RFgetModelInfo: Internal information

Description

The function returns internal information about the simulation of a random field and the calculation of covariance functions

Usage

RFgetModel(register, explicite.natscale, show.call=FALSE) 
RFgetModelInfo(register, level = 3,
               spConform = RFoptions()$general$spConform,
               which.submodels = c("submodels", "keys", "both"),
               modelname = NULL)

Arguments

$0,...,21$ or an evaluating function, e.g. RFsimulate. Place where intermediate calculations are stored; The user should only use the registers $0,..,9$ for the user's own purpose.

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

show.call

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

level

integer [0..9]; level of details, i.e. the higher the number the more details are given. If level >= 10 then the leading internal model is also given (which is, in general, not of interest by the user).

spConform

see RFoptions

which.submodels

Internally, the sub-models are represented in two different ways keys and submodels. The latter is very close to want the model defined the user.

modelname

string. If modelname is given then it returns the first appearance of the covariance model with name modelname. If meth is given then the model within the method is returned.

Value

List of internal information is returned.

Details

RFgetModelInfo(register, ignore.active=TRUE) is useful for debugging and specialists' need to control the algorithm, see the examples in RFoptions and RFsimulate. If RFoptions()$Storage=FALSE then values of the internal registers are not kept if RFsimulate has been called. Hence RFgetModelInfo cannot provide any information.

Examples

Run this code

set.seed(0)
model <- RMexp(scale=4, var=2) + RMnugget(var=3) + RMtrend(mean=1)
RFsimulate(model, 1:4, grid=TRUE, storing=TRUE)
str(RFgetModelInfo(RFsimulate), list.len=5, max.level=5)

### finally, a register that could not be successfully initialised
##try(RFsimulate(Circulant(model), runif(4), grid=FALSE, storing=TRUE))
##if (interactive()) Print(RFgetModelInfo(RFsimulate, TRUE))

str(RFgetModel(RFsimulate, show.call=FALSE))
str(RFgetModel(RFsimulate, show.call=TRUE))