scarabee.directory {scaRabee} | R Documentation |
Creation of the Run Directory
Description
scarabee.directory
is a secondary function called at each
scaRabee run. It creates a directory to store the results of the run and
a sub-directory to backup all files used for the run. This directory is
referred to as the 'run directory' in all scaRabee documentation and
help. scarabee.directory
is typically not called directly by users.
Usage
scarabee.directory(curwd = getwd(),
files = NULL,
runtype = NULL,
analysis = NULL)
Arguments
curwd |
The current working directory. |
files |
A list of input used for the analysis. The following elements are expected and none of them could be null:
|
runtype |
A character string, indicating the type of analysis. Should be 'simulation', 'estimation', or 'gridsearch'. |
analysis |
A character string directly following the $ANALYSIS tag in the model file. |
Value
When scarabee.directory
is called, a new folder is created in the
working directory. The name of the new folder is a combination of the string
directly following the $ANALYSIS tag in the model file, an abbreviation of the
type of run ('est' for estimation, 'sim' for simulation, or 'grid' for grid
search) and an incremental integer, e.g. 'test.est.01'. This directory
contains the text and graph outputs of the run.
Additionally, a sub-directory called run.config.files
is created into
the new folder and all the files defining the run, i.e. the dataset, the file
of initial model parameters, the model file and the master R script), are
stored.
Author(s)
Sebastien Bihorel (sb.pmlab@gmail.com)