GMPM-class: GMPM Model Classes

In dalejbarr/gmpm: Generalized Multilevel Permutation Models

Description

S4 objects containing information about GMPMs.

Objects from the Class

The class ‘GMPM’ is a virtual class: No objects may be created from it. The function gmpmCreate chooses the type of class to be created, either GMPM.glm, GMPM.mul, or GMPM.user, depending on the value passed to the ‘family’ argument of the function gmpmCreate or gmpm.

Objects of type GMPM.glm fit models using the underlying regression function glm.

Object of type GMPM.mul fit models using the underlying function multinom from package nnet.

The class GMPM.user is intended to allow users to specify their own regression functions (e.g., calls to nonlinear regression), but has not yet been implemented.

Slots

df1:

a "data.frame" object containing the model frame

dform:

"formula" specifying the structure of the model without the multilevel grouping factor. This is necessary for passing along to the underlying regression function

mform:

The full "formula" describing the model, including the multilevel grouping factor

munit:

Object of type "character" identifying the name of the variable in the model frame that defines the multilevel units

nunits:

An integer corresponding to the number of multilevel units in the model frame

gmpmControl:

A "list" with control arguments for the fitting function (see gmpm)

fitcall:

The call to the underlying function, cast as a "list"

famtype:

A human-readable redescription of the family of model

DVname:

A string specifying the name of the dependent variable

ivix:

A numeric vector giving the indices of the permuted variables in the permutation matrix (i.e., variables for which p-values are obtained).

IVinfo:

Human-readable information about the independent variables (IVs)

nWithin:

Number of ‘within unit’ IVs

nBetween:

Number of ‘between unit’ IVs

ivWithin:

vector of names of within-unit IVs

ivBetween:

vector of names of between-unit IVs

ivars:

vector of names of all IVs

IVcoef:

A "list" of all IVs and the names in the regression output

covars:

A vector of strings identifying the covariates in the model (anything on the right hand side of the formula that is not an IV is assumed to be a covariate)

coefTerms:

Object of class "list" ~~

psBetween:

A "data.frame" giving the permutation scheme for between-subject variables

psWithin:

A "list" giving the permutation scheme for within-subject variables

pspace:

Number of possible permutations

pmx:

The permutation matrix (or array, for GMPM.mul objects)

nCellsPerUnit:

Number of within-subject cells per sampling unit

ncomp:

Number of Monte Carlo runs completed

convergence:

A logical vector specifying whether or not a given run converged (GMPM.mul only)

Methods

initialize

signature(.Object = "GMPM"): ...

show

signature(object = "GMPM"): ...

summary

signature(object = "GMPM"): ...

mdTest

signature(x = "GMPM", y = "vector"): ...

mdTest

signature(x = "GMPM", y = "matrix"): ...

See Also

gmpm

dalejbarr/gmpm documentation built on May 14, 2019, 3:31 p.m.