@@ -13,14 +13,14 @@ Feel free to give feedback and feature requests or to take part in the developme
# PlotID.TagPlot()
`[figs, IDs] = TagPlot(figs, options)`
TagPlot adds IDs to figures
The ID is placed visual on the figure window and as Tag (property of figure)
TagPlot can tag multiple figures at once. If a single Plot is taged IDs is a char, otherwise it is a cell array of chars
_options_
<details><summary>detailed description</summary>
you find the options for plotID below. The data is in curled braces and the default value follows the equal sign.
_options_\
you find the options for TagPlot below. The data is in curled braces and the default value follows the equal sign.
- ProjectID {mustBeText}= ''
- Fontsize {mustBeInteger} = 8
...
...
@@ -30,7 +30,7 @@ you find the options for plotID below. The data is in curled braces and the defa
options.ProjectID is the project number (string or char), if empty the ID from the config file is used
The ID is placed on the 'east' of the figure per default, if you want it somwhere else, use the 'Location' option. 'north','east','south','west' are predefined, otherwise use the 'custom' option and provide the desired 'Position' (relative to your x- and y-axis limits)
</details>
## CreateID()
`function [ID] = CreateID(method)`\
CreateID Creates an identifier (char). It creates an (sometimes unique) identifier based on the selected method,if no method is selected method 1 will be the default method.
...
...
@@ -45,26 +45,54 @@ Static factory to retrieve a type 4 (pseudo randomly generated) UUID. The UUID i
FriendlyID Changes the Hex Number to a human friendly datetime and dateStr. IDf returns the ID as DateTime Object, PrjID returns the ProjectID, Str returns the timestamp as String. \
**This only works with ID method 1.**
# PlotID.Publish()
`Publish(DataPaths, ID, 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 an
path is used, PlotId will use this path a storagePath
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
<details><summary>detailed description</summary>
_options_\
you find the options for publish below. The data is in curled braces and the default value follows the equal sign.
'local' creates the folder in your current working path, 'server' on a remote path that needs to be specified in the config file. 'manual' opens an UI Window where the path must be choosen, 'CI-Test' is for CI testing only.
'individual' each folder contains the assigned data files. (recommended for small file sizes and for sharing).
'centralized' one central data folder is used for saving the research data files, the subfolders contain linked hdf5-files (if hdf5 is used). This is recommended, if many plots are made from the same data set. Attention, the linked HDF5 will not work when a subfolder was moved or the data folder was deleted.
- ParentFolder {mustBeText} = 'export'\
An individual folden name can be set with this option.
- CopyUserFCN {mustBeNumericOrLogical} = true \
All user functions that are used by script that calls publish will be exported per default as well. Set this to false (not recommended) to prevent this.
- CSV {mustBeNumericOrLogical} = false \
An overview of all published plots and the associated data will be stored in a csv file.
createLinkedHDF5 creates a HDF file that references the Sourcefile. TargetPath is the storage location, ID the foldername, Status returns true if the function was sucessfull.
## fileCompare()
`[status, id] = fileCompare(filename,fileList)`\
fileCompare checks if file1 is (binary) identical to a file in filelist, it returns a sttus and the id of the identical file. The function uses the windows system function fc or the unix function diff (not tested).
## removePltIdFiles()
`[fListClean] = removePltIdFiles(fList)`\
removePltIdFiles removes functions that are part of PlotID out of flist.
# How to use the .config file
The config file is a JSON-File. At the moment two options can be set in the config file, the project ID and the remote Path.
