CheckInput: Checking Input

Description Usage Arguments Author(s) See Also

View source: R/Utility.r

Description

Subroutine called by the fitting procedures. The procedure controls the the validity of the input inserted by the users.

Usage

1
2
3
4
5
CheckInput(coordx, coordy, coordt, corrmodel, data, distance,
           fcall, fixed, grid, likelihood, margins, maxdist,
           maxtime, model, numblock, optimizer, param, replicates,
           start, taper, tapsep, threshold, type, varest, vartype,
           weighted)

Arguments

coordx

A numeric (d x 2)-matrix (where d is the number of points) assigning 2-dimensions of coordinates or a numeric vector assigning 1-dimension of coordinates.

coordy

A numeric vector assigning 1-dimension of coordinates; coordy is interpreted only if coordx is a numeric vector otherwise it will be ignored.

coordt

A numeric vector assigning 1-dimension of temporal coordinates.

corrmodel

String; the name of a correlation model, for the description see FitComposite.

data

A numeric vector or a (n x d)-matrix or (d x d x n)-matrix of observations.

distance

String; the name of the spatial distance. The default is Eucl, the euclidean distance. See the Section Details.

fcall

String; Fitting to call the fitting procedure and simulation to call the simulation.

fixed

A named list giving the values of the parameters that will be considered as known values. The listed parameters for a given correlation function will be not estimated, i.e. if list(nugget=0) the nugget effect is ignored.

grid

Logical; if FALSE (the default) the data are interpreted as a vector or a (n x d)-matrix, instead if TRUE then (d x d x n)-matrix is considered.

likelihood

String; the configuration of the composite likelihood. Marginal is the default.

margins

String; the type of the marginal distribution of the max-stable field.

maxdist

Numeric; an optional positive value indicating the maximum spatial distance considered in the composite-likelihood computation.

maxtime

Numeric; an optional positive value indicating the maximum temporal lag separation in the composite-likelihood.

model

String; the density associated to the likelihood objects. Gaussian is the default.

numblock

Numeric; the number of observation of the underlying randfom field (only for max-stable simulations). See RFsim.

optimizer

String; the optimization algorithm (see optim for details). 'Nelder-Mead' is the default.

param

A numeric vector of parameters, needed only in simulation. See RFsim.

replicates

Logical; if FALSE (the default) one spatial random field is considered, instead if TRUE the data are considered as iid replicates of a field.

start

A named list with the initial values of the parameters that are used by the numerical routines in maximization procedure. NULL is the default.

taper

String; the name of the tapered correlation function.

tapsep

Numeric; an optional value indicating the separabe parameter in the space time quasi taper (see Details).

threshold

Numeric; a value indicating a threshold for the binary random field.

type

String; the type of the likelihood objects. If Pairwise (the default) then the marginal composite likelihood is formed by pairwise marginal likelihoods.

varest

Logical; if TRUE the estimate' variances and standard errors are returned. FALSE is the default.

vartype

String; the type of estimation method for computing the estimate variances, see FitComposite.

weighted

Logical; if TRUE the likelihood objects are weighted. If FALSE (the default) the composite likelihood is not weighted.

Author(s)

Simone Padoan, simone.padoan@unibocconi.it, http://faculty.unibocconi.it/simonepadoan; Moreno Bevilacqua, moreno.bevilacqua@uv.cl, https://sites.google.com/a/uv.cl/moreno-bevilacqua/home.

See Also

FitComposite


CompRandFld documentation built on Jan. 10, 2020, 9:08 a.m.