RFgetModel: Internally stored model

Description Usage Arguments Details Value Note See Also Examples

View source: R/getNset.R

Description

The function returns the stored model.

Usage

1
2
RFgetModel(register, explicite.natscale, show.call=FALSE,
           origin="original")

Arguments

register

0,...,21 or an evaluating function, e.g. RFsimulate. Place where intermediate calculations are stored. See also section Registers in RFoptions.

explicite.natscale

logical. Advanced option. If missing, then the model is returned as stored. If FALSE then any RMnatsc is ignored. If TRUE then any RMnatsc is tried to be combined with leading RMS, or returned as such.

show.call

logical or character. If FALSE then the model is shown as interpreted. If TRUE then the user's input including the calling function is returned. See example below.

If show.call is a character it behaves as which.submodels.

origin \argOrigin

Details

Whereas RFgetModel returns a model that can be re-used by the user, RFgetModelInfo can return detailed information.

Value

The stored model is returned in list format.

Note

Put Storing=TRUE, see RFoptions, if you like to have (more) internal information in case of failure of an initialization of a random field simulation.

See Also

RFgetModelInfo, RFsimulate.

Examples

1
2
3
4
5
6
RFoptions(seed=0) ## *ANY* simulation will have the random seed 0; set
##                   RFoptions(seed=NA) to make them all random again
model <- RMexp(scale=4, var=2) + RMnugget(var=3) + RMtrend(mean=1)
z <- RFsimulate(model, 1:4)
RFgetModel(show.call=FALSE)
RFgetModel(show.call=TRUE)

RandomFields documentation built on Feb. 6, 2020, 5:13 p.m.