Update Save Options: links & code authored by Fabian Berg's avatar Fabian Berg
......@@ -2,7 +2,7 @@
## errorSave
function: errorSave
function: [errorSave](https://gitlab.ruhr-uni-bochum.de/ikn/OTBR/-/blob/master/Tools/errorSave.m)
**Description**
This function is used to warn the user that something went wrong in a program. This function should be used in every Experiment! It has to be called from within a catch-statement where it opens an error-warning and saves all workspace variables so that no data is lost. The workspace is saved to the file ErrorTermination_jjjjmmddhhmm.mat in the working directory.
......@@ -19,7 +19,7 @@ catch
## getBasicInformation
function: trial = getBasicInformation
function: trial = [getBasicInformation](https://gitlab.ruhr-uni-bochum.de/ikn/OTBR/-/blob/master/Tools/getBasicInformation.m)
**Description**
Use this function to get basic information about the experimental computer, the user and the date and time when the experiment was started. Useful when several people run experiments on the same device.
......@@ -42,12 +42,12 @@ Use this function to get basic information about the experimental computer, the
## save2File
function: [fileName,savePath] = save2File(varargin)
function: [fileName,savePath] = [save2File(varargin)](https://gitlab.ruhr-uni-bochum.de/ikn/OTBR/-/blob/master/Tools/save2File.m)
**Description**
Saves given variables to a MATLAB workspace file. This function is useful to save results into a workspace file that can be evaluated afterwards. The first arguments have to be the variables that should be stored in the workspace file.
save2File uses a default file name (year-month-day-hour-minute), if no optional arguments are used and saves the file into the current directory.
[save2File](https://gitlab.ruhr-uni-bochum.de/ikn/OTBR/-/blob/master/Tools/save2File.m) uses a default file name (year-month-day-hour-minute), if no optional arguments are used and saves the file into the current directory.
Additional arguments gain more control over the filename and the path. Existing files are untouched, even if the user enters the same filename again. Files are renamed automatically and a warning appears.
......@@ -86,11 +86,11 @@ Additional arguments gain more control over the filename and the path. Existing
~~~
**See also**
bioErrorSave, save, save2ExcelFile
[bioErrorSave](https://gitlab.ruhr-uni-bochum.de/ikn/OTBR/-/blob/master/Obsolete/bioErrorSave.m), [save](https://de.mathworks.com/help/matlab/ref/save.html), [save2ExcelFile](/Save-Options#save2excelfile)
## save2ExcelFile
function: save2ExcelFile(filename, mat, varargin)
function: [save2ExcelFile(filename, mat, varargin)](https://gitlab.ruhr-uni-bochum.de/ikn/OTBR/-/blob/master/Tools/save2ExcelFile.m)
**Description**
This is a wrapper function that allows OTBR Toolbox users to create Excel files either in MATLAB or in Octave on a Raspberry pi! To create Excel files in the Raspberry Pi the package IO has to be installed.
......@@ -106,7 +106,7 @@ This is a wrapper function that allows OTBR Toolbox users to create Excel files
**Inputs-optional**
~~~
varargin sheetName renames Excel sheet, needs fourth argument sheetname
varargin 'sheetName' renames Excel sheet, needs fourth argument sheetname
sheetname defines the sheet name where the data are stored as string
~~~
......@@ -122,7 +122,7 @@ This is a wrapper function that allows OTBR Toolbox users to create Excel files
## getCode
function: [cde] = getCode(funNme)
function: [cde] = [getCode(funNme)](https://gitlab.ruhr-uni-bochum.de/ikn/OTBR/-/blob/master/Tools/getCode.m)
**Description**
Returns the code of the named function (*.m file) as unit8. Hast to be casted to char for human reading.
......@@ -139,11 +139,11 @@ Returns the code of the named function (*.m file) as unit8. Hast to be casted to
~~~
**See also**
saveCode
[saveCode](/Save-Options#savecode)
## saveCode
function: [] = saveCode(fName, cde)
function: [] = [saveCode(fName, cde)](https://gitlab.ruhr-uni-bochum.de/ikn/OTBR/-/blob/master/Tools/saveCode.m)
**Description**
Use this function to save the output of getCode as *.m file.
......@@ -156,4 +156,4 @@ Use this function to save the output of getCode as *.m file.
~~~
**See also**
getCode
\ No newline at end of file
[getCode](/Save-Options#getcode)
\ No newline at end of file