RPPANormalizationParams-class {RPPASPACE}

Class “RPPANormalizationParams”

Description

The RPPANormalizationParams class is used to bundle the parameter set together that control how to perform spatial adjustment into a reusable object.

Usage

RPPANormalizationParams(method,
                        arglist=NULL)
is.RPPANormalizationParams(x)
## S4 method for signature 'RPPANormalizationParams'
paramString(object, slots, ...)

Arguments

method

character string specifying normalization method to use

arglist

list of named key/value pairs representing argument list to be passed upon invocation of normalize method

object

object of class RPPANormalizationParams

x

object of class RPPANormalizationParams

slots

strings specifying RPPANormalizationParams slotnames to display (for debugging)

...

extra arguments for generic routines

Details

The method argument is combined with the arglist argument prior to invocation of normalize method.

Value

The RPPANormalizationParams generator returns an object of class RPPANormalizationParams.

The is.RPPANormalizationParams method returns TRUE if its argument is an object of class RPPANormalizationParams.

The paramString method returns a character vector, possibly empty but never NULL.

Objects from the Class

Although objects of the class can be created by a direct call to new, the preferred method is to use the RPPANormalizationParams generator function.

Slots

name:

character string; see arguments above

method:

character string; see arguments above

arglist:

list of named key/value pairs; see arguments above

Methods

paramString

signature(object = "RPPANormalizationParams"):
Returns string representation of object.

Warning

The paramString method should not be called by user except for informational purposes. The content and format of the returned string may vary between different versions of this package.

Author(s)

P. Roebuck [e-mail], James M. Melott [e-mail]

See Also

normalize

Examples

showClass("RPPANormalizationParams")
normparams <- RPPANormalizationParams(method="medpolish",
                                      arglist=list(calc.medians=FALSE))
paramString(normparams)