Description Usage Arguments Details See Also
View source: R/RProcessStart.R
This module starts a custom R script.
Together with RProcessFinish
this module can start and observe a custom R script as background process.
Both functions are combined in a convenience function RProcess
.
1 2 |
input |
argument used by shiny session |
output |
argument used by shiny session |
session |
argument used by shiny session |
trigger |
reactive which starts the process (e.g. action button input) |
object |
reactive object that will be handed over to R batch script as input |
script |
|
logFile |
|
sessionid |
|
pwd |
|
checkFun |
|
addArgs |
|
If this function is used together with RProcessFinish
, they both need to be called with the same id
and the same pwd
(working directory).
The communication between the shiny session and the R script is done via a *.status
file.
Input and output are handed over via a *.rds
file.
The working directory of the process can be defined with pwd
.
This is where the files are read and written as well.
There is the option to let the R script write a log.
The desired log file can be given with logFile
.
If several users use the app it might be useful to include a unique id with sessionid
.
Every log entry will be appended with it.
With checkFun
a function name can be defined which will be used as quality control for object
.
This function is run before the R batch script is started.
First argument of this function is the object
.
The function must either return NULL
or a chr
value. NULL
means the input is valid.
Thereby the module will start the R script.
If the input should not be valid, the function must return a character value.
This chr
will be rendered as a error message for the user, and the modul will not start the R script.
Additional arguments to this checkFun
can be handed over with addArgs
.
To ensure that the communication between the shiny session and the R script is working properly, use Rscript_Init
to start the script and Rscript_Fin
to finish it.
These functions belong to the Rscript communication function which should be used in the R script for communication with the shiny session.
For examples see the vignette on RProcess Module Functions (vignette("RProcess_functions", package = "shinyTools")
).
Seome examples on how to use RProcess module functions are given in the vignette RProcess Module Functions
(vignette("RProcess_functions", package = "shinyTools")
)
In the R script communications functions such as Rscript_Init
and Rscript_Fin
should be used
to ensure correct communication between the R script and the shiny session.
Other RProcess module functions: RProcessFinishUI
,
RProcessFinish
,
RProcessStartUI
, RProcessUI
,
RProcess
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.