pim.environment-class: The pim.environment class

In pim: Fit Probabilistic Index Models

The pim.environment class

Description

This S4 class inherits from the S3 class environment. The environment serves as a container to hold the data, poset and the poset related functions of a probabilistic index model generated by the function pim. The objects of this class behave much like an environment, but contain some extra slots with information on the objects inside the environment.

Slots

poset

an environment of class pim.poset containing the poset-related functions (normally these are L and R). This environment has the object itself as parent.

data.names

a character vector containing the names of the vectors that represent the data

nobs

integer value indicating the number of observations in the environment

classes

a _named_ list containing the classes of the objects inside the environment. Note that the value should be the one given by class.

is.complete

a logical value indicating whether or not the poset was added before.

Note

This class is not exported, so it can't be extended as for now. Although it is possible to use the function new for creation of new instances, users are strongly advised to use the function new.pim.env in case they need to manually create a new instance of the class pim.environment.

pim documentation built on April 3, 2025, 9:30 p.m.