Rscript_Log: Rscript_Log

Description Usage Arguments Details Value See Also

View source: R/ProcessFunctions.R

Description

This function is used to write log messages for a R script run by a RProcess module such as RProcess.

Usage

1
Rscript_Log(msg, info = NULL)

Arguments

msg

chr arr with log messages. Each element is a line.

info

ProcessInfo object or NULL (NULL). This is a list of relevant information about the process. It can be created with RProcessInit. If NULL the global environment is searched for an object of class ProcessInfo.

Details

If a log file exists, it is appended by the lines defined in with msg. Each element of msg is a line. Information about path of the log file, the session id and the process id is taken from the ProcessInfo object (see arguments). If a session id exists, every line is prefixed with it. If a process id exists, before writing anything the loaded process id is compared with the current one – read from the *.status file. If they do not match, the R session ends with a call to quit. This ensures that, in case a newer version of the same process is running, the current one will quit and not overwrite anything.

Value

TRUE if a log was written, FALSE if not

See Also

These Rscript communication functions are used in R scripts started by a RProcess module such as RProcess. For some examples on how they work together see the vignette RProcess Module Functions.

Other Rscript communication functions: ReadInfo, Rscript_Abort, Rscript_Fin, Rscript_Init, Rscript_Start, Rscript_Try, Rscript_Up


mRcSchwering/shinyTools documentation built on May 21, 2019, 10:14 a.m.