mcsContainer-class: Class '"mcsContainer"'
In sampSurf: Sampling Surface Simulation for Areal Sampling Methods

Description Objects from the Class Slots Methods Note Author(s) References See Also Examples

This class allows one to store a collection of objects that are all a subclass of "MonteCarloSampling."

Objects can be created by calls of the form new("mcsContainer", ...). However, using the constructor methods with the same name as the subsampling method used is preferred (see mcsContainer). Please refer to the vignette reference below for more examples.

mcsObjs:: Object of class "list": Each object in the list must be of the same class for a valid object.
stats:: Object of class "matrix": Summary statistics for the objects in slot mcsObjs.
description:: Object of class "character": A character description of the contents if desired.

antitheticSampling: signature(object = "mcsContainer"): Apply antithetic sampling to each object in the collection.
hist: signature(x = "mcsContainer"): Generate histograms for the collection.
plot: signature(x = "mcsContainer", y = "missing"): Plot the container collection.
show: signature(object = "mcsContainer"): Print a summary.
summary: signature(object = "mcsContainer"): Print a summary.

Please note that this is not a completely functional container class in the traditional sense at present as it does not have replacement, deletion, or addition functions. If you need to do any of these operations, perform them on the list object (in the mcsObjs slot) and then recreate the container. If the object is not re-built after, e.g., deletion, the summary statistics will be incorrect.

Jeffrey H. Gove