SPRproject {systemPipeR} | R Documentation |
Function to construct SYSargsList
workflow control environment (S4 object).
This function creates and checks the directory structure. If the expected directories
are not available, it is possible to create those.
The project directory structure expected is:
SPRproject/
data/
param/
results/
The project working directory default structure of the project directories can be modified here.
SPRproject(projPath = getwd(), data = "data", param = "param", results = "results", logs.dir= ".SPRproject", sys.file="SYSargsList.yml", envir = new.env(), restart = FALSE, resume=FALSE, load.envir = FALSE, overwrite = FALSE, silent = FALSE)
projPath |
a character vector of a full project path name. Default is the current path. |
data |
a character vector of a |
param |
a character vector of a |
results |
a character vector of a |
logs.dir |
a character vector of a |
sys.file |
name and path of the SYSargsList file which will store all the project configuration
information. Default is |
envir |
the environment in which expr is to be evaluated. Default will create a |
restart |
if set to TRUE, existing |
resume |
if set to TRUE, existing SYSargsList save in the directory will be used to resume the workflow. |
load.envir |
after running the workflow, the environment can be saved on disk. This argument
allows to load the environment and recover all the objects. This argument can be set
as |
overwrite |
if set to TRUE, existing logs files or directory of same name will be overwritten. |
silent |
if set to TRUE, all messages returned by the function will be suppressed. |
If an SYSargsList
instance was created before or independent of the
project initialization, it is possible to append this instance after the
project is created. Please see check appendStep<-
function.
SPRproject
will return a SYSargsList
object.
Daniela Cassol
See also as SYSargsList-class
.
sal <- SPRproject(projPath = tempdir()) sal