Learn R Programming

MRIaggr (version 1.1.5)

initParameter: parameter initialization

Description

Check and initialize the param argument in MRIaggr methods. For internal use.

Usage

"initParameter"(object, param, test = TRUE, init = FALSE, accept.coords = TRUE, accept.mask = TRUE, accept.index = TRUE, arg_name = "param", long_name = "parameters", method)

Arguments

object
an object of class MRIaggr.
param
the contrast parameters to check or initialize. character vector or NULL.
test
should the parameters be checked ? logical.
init
should the parameters be initialized if param equals NULL ? logical.
accept.coords
should coordinates be accepted as parameters ? logical.
accept.mask
should mask be accepted as a parameter ? logical.
accept.index
should index be accepted as a parameter ? logical.
arg_name
a short name for the error message. character.
long_name
the complete name for the error message. character.
method
the name of the function that called the initializer. character.

Details

ARGUMENTS : Setting param to NULL leads to load all available parameters including coodinates, mask and index if accept.coords, accept.mask or accept.index are respectively set to TRUE.