setBaselineParameters: Set, read, get or modify baseline parameters.

Description Usage Arguments Value

View source: R/rstox_base.r

Description

setBaselineParameters Sets baseline parameters in memory to new values specified in parlist or ....

readBaselineParametersJava Reads the baseline parameters from the Java memory.

readBaselineParameters Depricated and no longer maintained, use readBaselineParametersJava instead: Reads the baseline parameters from the project.xml file

getBaselineParameters Gets either original, java or last used baseline parameters

modifyBaselineParameters Only modifies the parameters in parameters using those in parlist and .... This function does not change the values other than in the return of the function (not in the RstoxEnv environment nor in the project file).

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
setBaselineParameters(projectName, msg = FALSE, parlist = list(),
  save = c("last", "java"), ...)

readBaselineParametersJava(projectName, out = "baseline",
  keepMissing = FALSE)

readBaselineParameters(projectName, rver = "1")

getBaselineParameters(projectName, out = "all")

modifyBaselineParameters(parameters, parlist = list(), ...)

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

msg

Logical; if TRUE print old and new parameters.

parlist

List of parameters values overriding existing parameter values. These are specified as processName = list(parameter = value), for example AcousticDensity = list(a = -70, m = 10), BioStationWeighting = list(WeightingMethod = "NASC", a = -70, m = 10). Numeric parameters must be given as numeric, string parameters as string, and logical parameters (given as strings "true"/"false" in StoX) can be given as logical TRUE/FALSE. New parameters can be set by setBaselineParameters() but not removed in the current version.

save

A string naming the types of parameter to save ("java" implies saving the parameters to Java memory and to RstoxEnv[[projectName]]$javaParameters, whereas "last" implies saving the parameters to RstoxEnv[[projectName]]$javaParameters and to the projectData which are saved along with bootstrap and impute data). If save=TRUE, save is set to c("java", "last").

...

Same as parlist, but can be specified separately (not in a list but as separate inputs).

rver

The version of the stox library.

parameters

A list of the baseline parameters to modify using parlist or ....

project

The project Java object.

Value

The original parameters


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