Commit e353c936 authored by Hock, Martin's avatar Hock, Martin 🙉
Browse files

Merge branch 'improv/readme-updates' into 'master'

Multiple updates to readme incl. typos, wording, and corrections.

See merge request !81
parents b9cb853f 93800f1b
Pipeline #672057 passed with stage
in 55 seconds
......@@ -43,7 +43,7 @@ PlotID.Publish(rdata, script, fig);
```
**Please take also a look on the examples provided in the Example folder**.
**For further insight, please take a look at the examples provided in the Example folder**.
# PlotID.TagPlot()
......@@ -87,51 +87,51 @@ 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. \
**This only works with ID method 1.**
**This only works with ID method 1 (UNIX Time as Hex).**
# PlotID.Publish()
`Publish(DataPaths,scriptPath, 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), 'manual' opens an explorer window, where you can choose the desired folder. If you define a export path in the config file, this will used per default (exportPath).
Location sets the storage location. 'local' sets the storage location to the current folder (an export folder will be created), 'manual' will allow you to choose a folder via user dialogue. If you defined an export path in the config file, this will used per default (exportPath).
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.
Two Methods are implemented: 'individual' stores the data for each plot with the plot while 'centralized' uses a single data folder and creates 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 as 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.
You can find the possible options for publish below. The the possible parameters are listed in curled braces and the default value follows the equal sign at the end.
- Location {mustBeMember(options.Location ,{'local','server','manual','CI-Test'})} = 'local' \
'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.
'local' creates the folder in your current working path, 'server' will use a remote path that needs to be specified in the config file. 'manual' opens an UI window where the path must be selected, 'CI-Test' is for CI testing only.
- Method {mustBeMember(options.Method ,{'individual','centraliced'})} = 'individual'\
'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.
'individual' each folder contains the assigned data files. (recommended for small file sizes and for sharing fully functional packages).
'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 multiple 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.
Adjust the default parent folder name for exports.
- 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.
An overview of all published plots by ID and their associated data will be stored in a .csv file.
</details>
## createFileCopy ()
`[] = createFileCopy(filePaths,folderName,storPath,ID,type)`\
Creates a copy of the files (can be used for multiple paths in a cell array). folderName is the name of the exporting folder
Creates a copy of files (can be used for multiple paths in a cell array). folderName is the name of the exporting folder
## createLinkedHDF ()
`[status] = createLinkedHDF5(SourceFile,TargetPath,ID)` \
createLinkedHDF5 creates a HDF file that references the Sourcefile. TargetPath is the storage location, ID the foldername, Status returns true if the function was successfull.
createLinkedHDF5 creates an HDF file that references the source file. TargetPath describes the storage location, ID the foldername, status returns 'true' if the function was successfull.
## 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).
fileCompare checks if file1 is (binary) identical to a file in filelist, it returns a status and the id of the identical file. The function uses the windows system function fc or the unix function diff.
## 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. The config file stores user data and options of `PlotID`. It will be created when you use PlotID for the first time. Follow the Instructions to create the file. _Note:_ for basic usage no manual changes on the config file are required. \
The config file is a JSON-File. The config file stores user settings and options of `PlotID`. It will be created when you use PlotID for the first time. Follow the Instructions to create the file. _Note:_ for basic usage no manual changes on the config file are required. \
**Note:** If you mess up your config-file simply delete it, PlotID will create a new one the next time you use it.
**Note:** If you mess up your config-file simply delete it, PlotID will prompt you to create a new one the next time you use it.
## Default config.json
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment