RProcessFinish: RProcessFinish

In mRcSchwering/shinyTools: shinyTools

Description

This module observes a custom R script. Together with RProcessStart this module can start and observe a custom R script as background process. Both functions are combined in a convenience function RProcess.

Usage

RProcessFinish(input, output, session, pwd = getwd(), millis = 1000)

Arguments

input	argument used by shiny session
output	argument used by shiny session
session	argument used by shiny session
pwd	chr (getwd()) path of R batch process working directory.
millis	int (1000) of the time interval in milli seconds in which to read the *.status file for possible changes

Details

If this function is used together with RProcessStart, 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.

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")).

Value

list with elements 4 elements

• finished indicating the time at which the R script has finished (NULL if not finished yet)

• result the actual output of the R script (NULL if not finished yet)

• error if the R script finished with an error, a relevant message is given here as chr (NULL if no error occured)

• progress num indicating progress of R script (1 if finished, [0,1[ if running, NULL otherwise)

See Also

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, RProcessStartUI, RProcessStart, RProcessUI, RProcess

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