sampSurf (version 0.7-6)

monte-class: Class "monte"

Description

This is the class that contains the information about a basic repeated sampling (Monte Carlo) run. The class makes use of several other classes in the package that should be consulted for details. Also, the vignette referenced below is a good source of extended information and examples of how this class would be used.

Objects from the Class

Objects can be created by calls of the form new("monte", ...). However, use of the constructor generic "monte" with methods for creating objects is recommended. This is to be preferred over the use of new since the objects returned from the constructor are guaranteeted to be valid.

Slots

pop:

Object of class "montePop": A Monte Carlo population object, please see '>montePop for details.

%\item{\code{zeroTruncated}:}{Object of class \code{"logical"}: %\code{TRUE} if the population has been zero-truncated; \code{FALSE} %otherwise. This is mostly relevant for \code{\linkS4class{sampSurf} objects. }

estimate:

Object of class "character": In the case of sampSurf objects, this is the attribute for which the surface has been estimated.

NTsamples:

Object of class "monteNTSampleOrNULL": An object of class '>monteNTSample, or NULL if non-existent. See the constructor for details.

BSsamples:

Object of class "monteBSSampleOrNULL": An object of class '>monteBSSample, or NULL if non-existent. See the constructor for details.

description:

Object of class "character": Some descriptive text about the object.

Methods

hist

signature(x = "monte"): Generate a set of histograms.

show

signature(object = "monte"): Print the object summary succinctly.

summary

signature(object = "monte"): Print the object summary.

References

The ‘“monte”: When is n Sufficiently Large?’ vignette.

See Also

'>montePop, '>monteSample

Examples

# NOT RUN {
showClass("monte")
# }