runFunsRstox: Get various plots and reports in Rstox

Description Usage Arguments Value

View source: R/rstox_reports.r

Description

runFunsRstox Runs all functions starting with the input parameter string.

getFunsRstox Gets all functions starting with the input parameter string.

Usage

1
2
3
4
runFunsRstox(projectName, string, out = "all", options = "",
  all.out = FALSE, drop.out = TRUE, ...)

getFunsRstox(string, out = "all")

Arguments

projectName

The name or full path of the project, a baseline object (as returned from getBaseline or runBaseline, og a project object (as returned from openProject).

string

A string giving the first characters of the functions to run, such as "plot" or "report".

out

A string vector giving the plot or report functions to run. See getRstoxEnv()$keywords for available keywords.

options

A string vector holding the parameters passed on to the plotting functions. These parameters overrides identically named parameters in '...'. The parameters must be formatted as R expressions (as typed into an R console), and separated by semicolons (";"). See examples below:

"Single string"

"string = 'a string'"

"String vector"

"stringvec = c('red', 'blue', 'yellow2')"

"Numeric"

"num = 1.55"

"Numeric vector"

"numvec = c(1.4e-6, 16/3, runif(3))"

"Logical"

"ok = TRUE"

"Logical vector"

"okvec = c( TRUE, FALSE, T, F, set.seed(0); runif(3)>0.3 )"

"Array"

"arr = array(runif(12), dim=3:4)"

"Function"

"fun1 = function(x) sin(rev(x))"

All the examples in one string: options = "string = 'a string'; stringvec = c('red', 'blue', 'yellow2'); num = 1.55; numvec = c(1.4e-6, 16/3, runif(3)); ok = TRUE; okvec = c( TRUE, FALSE, T, F, runif(3)>0.3 ); arr = array(runif(12), dim=3:4); fun1 = function(x) sin(rev(x)); fun3 = runif"

all.out

Logical: if TRUE return all data from the functions, and otherwise only return file names.

drop.out

Should the list of be dropped if only one funciton is run?

...

Parameters passed on to the plotting functions.

Value

runFunsRstox returns a the outputs from alle the functions run, whereas getFunsRstox returns a vector of functions.


Sea2Data/Rstox documentation built on April 18, 2018, 11:11 p.m.