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

Update README.md

parent a6189561
Branches
Tags
2 merge requests!13PreRelease_V0.1,!12PreRelease_V0.1
Pipeline #561546 failed
...@@ -3,13 +3,25 @@ ...@@ -3,13 +3,25 @@
`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. `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`. 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. Feel free to give feedback and feature requests or to take part in the development process.
[TOC] [TOC]
# Quick User Guide # Quick User Guide
PlotID works in two Steps:
1. tagging the plot
`[figs, IDs] = plotId.TagPlot(figs, options)`
2. publishing the plot and the associated data
`plotID.Publish(DataPaths, ID, figure, options)`
`DataPaths.script = mfilename('fullpath');` contains the filename of the m.script
`DataPaths.rdata = {dataset1, dataset2};` file names of the datasets (they most be at the path)
# PlotID.TagPlot() # PlotID.TagPlot()
`[figs, IDs] = TagPlot(figs, options)` `[figs, IDs] = TagPlot(figs, options)`
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment