Skip to content
Snippets Groups Projects
Commit 8ec81a67 authored by Lemmer, Jan's avatar Lemmer, Jan
Browse files

Update README.md

parent 829361f1
Branches
Tags
2 merge requests!43Implements #73, cleans up example file,,!38Dev/example
Pipeline #593030 passed
**PlotID**
`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` 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.
......@@ -13,19 +11,25 @@ Feel free to give feedback and feature requests or to take part in the developme
# Quick User Guide
**Requirements:** MATLAB R2021a or newer
`PlotID` works in two Steps:
**First use:**
1. Put your PlotID folder in you [userpath](https://uk.mathworks.com/help/matlab/ref/userpath.html) on Windows this is
`C:\Users\USERNAME\Documents\MATLAB`. \
When using a diffrent folder, make sure the folder is on your [search path](https://uk.mathworks.com/help/matlab/matlab_env/add-remove-or-reorder-folders-on-the-search-path.html).
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. Run `Initialisation.m` and follow the command line instructions.\
The **ProjectID** is your custom project number, it well be the prefix of the ID created by `PlotID` (e.g. JL-001). Save your config file.
**Intended use:**\
`PlotID` works in two Steps:
2. publish the plot and the associated data
`plotID.Publish(DataPaths,scriptPath, figure, options)`
1. Tag the plot
`[figs, IDs] = PlotId.TagPlot(figs, 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.**
2. Publish the plot and the associated data
`PlotID.Publish(DataPaths,scriptPath, figure, options)`
`DataPaths` contains the path(s) to the research data, for multiple files you can use a cell arrays (they must be at the path).
`scriptPath` contains the path to the script, this can be provided with the simple call of `scriptPath = [mfilename('fullpath'),'.m']` \
`DataPaths` contains the path(s) to the research data, for multiple files you can use a cell arrays (they must be at the path). \
`figure` is the figure that should be published.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment