Revticulate (version 1.0.0)

doRev: Call RevBayes with Continuous Session History

Description

The basic Revticulate function for interacting with RevBayes

Usage

doRev(input, coerce = TRUE, evaluate = TRUE, viewCode = FALSE, timeout = 5)

Arguments

input

character - Rev language expression to execute in RevBayes

coerce

logical - If TRUE, the output from RevBayes will be coerced into R format with coerceRev()

evaluate

logical - If FALSE, input will be written to the .Revhistory file, but will not be interpreted in RevBayes. Default is FALSE.

viewCode

logical - If TRUE, Rev code input and output will be displayed in the viewing pane. Mostly used for development purposes.

timeout

integer - Determines how long the system2() call should wait before timing out. Default is 5 seconds. For longer calls, see 'callRevFromTerminal()'

Value

now - RevBayes output, type varies. If coerce = TRUE, coerceRev() will attempt to convert RevBayes output into an equivalent R object. If else, the return type is character.

Details

This function allows users to make multiple calls to RevBayes, while maintaining a persistent input history. This means that variables defined in one call can be referenced in another call, giving the feel of a continuous RevBayes session.

Because this function is the basis for repRev() and knitRev(), variables defined in RevBayes with any of these functions can be referenced by any of the others.

Examples

# NOT RUN {
doRev("simTree(16)", coerce=FALSE)
doRev("a <- 10")
doRev("a * 100")
# }
# NOT RUN {
# }