`PlotID` is a toolkit that labels your plots and figures and copies all associated data (research data, plotting script, user-functions and a copy of the figure) to the desired location.
This version of `PlotID` is build for `MATLAB`.
`PlotID` provides two core functions TagPlot and Publish which are described in Detail below.
Feel free to give feedback and feature requests or to take part in the development process.
[TOC]
# Quick User Guide
# 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_
you find the options for plotID below. The data is in curled braces and the default value follows the equal sign.
- ProjectID {mustBeText}= ''
- Fontsize {mustBeInteger} = 8
- Location {mustBeText} = 'east'
- Position {mustBeVector} = [1,0.4]
- Rotation {mustBeInteger} = 0
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)
## 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.
1.**UNIX Time in seconds as HEX**\
This is used by default due to its simplicity and it is human readable.
2.**random UUID from Java 128 bit.**\
Static factory to retrieve a type 4 (pseudo randomly generated) UUID. The UUID is generated using a cryptographically strong pseudo random number generator.
## friendlyID()
`[IDf,PrjID, Str] = friendlyID(ID)`\
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
