`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.
`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 works in two Steps:
`PlotID` works in two Steps:
1. tagging the plot
`[figs, IDs] = plotId.TagPlot(figs, options)`
...
...
@@ -25,27 +26,28 @@ PlotID works in two Steps:
# 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
**TagPlot** adds IDs to figures
The ID is placed visual on the figure window and as Tag (property of the figure)
**TagPlot** can tag multiple figures at once. If a single Plot is tagged, IDs is a char, otherwise it is a cell array of chars .
<details><summary>detailed description</summary>
_options_\
you find the options for TagPlot below. The data is in curled braces and the default value follows the equal sign.
you find the options for TagPlot below. The data type 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
- 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)
`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' as a vector relative to your x- and y-axis limits`[relX, relY]` .
</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.
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.
...
...
@@ -54,7 +56,7 @@ Static factory to retrieve a type 4 (pseudo randomly generated) UUID. The UUID i
## 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. \
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.**
...
...
@@ -94,8 +96,6 @@ fileCompare checks if file1 is (binary) identical to a file in filelist, it retu
`[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.
