on_start {rBiasCorrection} | R Documentation |
on_start helper function
Description
Internal function, that initializes plotdir, csvdir and logfilename.
Usage
on_start(plotdir, csvdir, logfilename, parallel)
Arguments
plotdir |
A character string. Path to the folder, where plots are saved. |
csvdir |
A character string. Path to the folder, where resulting tables are saved. |
logfilename |
A character string. Path to the logfile to save the log messages. |
parallel |
A boolean. If TRUE (the default value), initializing 'future::plan("multicore")' (on unix systems) or 'future::plan("multisession")' (on non-unix systems) before running the code. |
Value
This function silently creates the directories'plotdir' and 'csvdir' on the local filesystem and initializes the logfile, specified with 'logfilename'. Furthermore, if 'parallel = TRUE', the 'future'-backend is initialized.
See Also
Examples
# runtime > 5 sec.
plotdir <- paste0(tempdir(), "/plots/")
csvdir <- paste0(tempdir(), "/csv/")
logfilename <- paste0(tempdir(), "/log.txt")
parallel <- FALSE
on_start(plotdir, csvdir, logfilename, parallel)
[Package rBiasCorrection version 0.3.4 Index]