Skip to content
Snippets Groups Projects
Commit 8dfb6856 authored by Hock, Martin's avatar Hock, Martin
Browse files

Added a minimal example.

parent 773f7e01
No related branches found
No related tags found
1 merge request!73Docs/minimalexampleinreadme
Pipeline #669968 passed
......@@ -32,6 +32,17 @@ The **ProjectID** is your custom project number, it well be the prefix of the ID
`DataPaths` contains the path(s) to the research data, for multiple files you can use a cell array (We recommend using absolute paths). It is also possible to pass an arbitrary number of variables as struct. \
`figure` is the figure that should be published.
** Minimal Example:**
```matlab
fig = figure;
plot(x,y);
[fig, IDs] = PlotID.TagPlot(fig);
script = [mfilename('fullpath'),'.m']; % This creates a path to the script this line is called from
rdata = {'\\fullpath\dataset01.mat', '\\fullpath\dataset02.h5'} ; % a single path does not need a cell array
PlotID.Publish(rdata, script, fig);
```
**Please take also a look on the examples provided in the Example folder**.
......@@ -122,6 +133,9 @@ The config file is a JSON-File. The config file stores user data and options of
**Note:** If you mess up your config-file simply delete it, PlotID will create a new one the next time you use it.
## Default config.json
## Define an export path
If you define an export path in the config.json this path is used as location for the exported data.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment