From 06089ea46a3af7c1ed484fed426e71959c03feed Mon Sep 17 00:00:00 2001 From: "Lemmer, Jan" <jan.lemmer@fst.tu-darmstadt.de> Date: Tue, 26 Oct 2021 15:24:34 +0200 Subject: [PATCH] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 85a1982..8204d76 100644 --- a/README.md +++ b/README.md @@ -15,17 +15,17 @@ Feel free to give feedback and feature requests or to take part in the developme 1. tagging the plot `[figs, IDs] = plotId.TagPlot(figs, options)` +You should either set a ProjectID in the config.json (copy & rename the 'example-config.json' to 'config.json'), or pass it as option 'ProjectID' to the TagPlot function. - -2. publishing the plot and the associated data -`plotID.Publish(DataPaths,scriptPath, ID, figure, options)` +2. publish the plot and the associated data +`plotID.Publish(DataPaths,scriptPath, figure, options)` `scriptPath` contains the path to the script, this can be provided with the simple call of `scriptPath = [mfilename('fullpath'),'.m']`, note that **the extension is mandatory.** `DataPaths` contains the path(s) to the research data, for multiple files you can use a cell arrays (they must be at the path). - -You should either set a ProjectID in the config.json (copy & rename the 'example-config.json' to 'config.json'), or pass it as option 'ProjectID' to the TagPlot function. +`figure` is the figure that should be published. + # PlotID.TagPlot() `[figs, IDs] = TagPlot(figs, options)` @@ -64,7 +64,7 @@ FriendlyID Changes the Hex Number to a human friendly *datetime* and *dateStr*. # PlotID.Publish() -`Publish(DataPaths,scriptPath, ID, figure, options)` \ +`Publish(DataPaths,scriptPath, figure, options)` \ Publishes saves plot, data and measuring script Location sets the storage location. 'local' sets the storage location to the current folder (an export folder will be created), 'server' is a remote path, that is defined in the config file. Two Methods are implemented 'individual' stores the data for each plot while 'centralized' uses a data folder and uses reference links to the original data (hdf5 only). ParentFolder is the folder Name where the exported data is stored if a path is used, PlotId will use this path a storagePath -- GitLab