Covariates-class: S4 class to specify the covariates term of a prior.

In StatisticsNZ/demest: Bayesian Demographic Estimation and Forecasting

S4 class to specify the covariates term of a prior.

Description

An object of class Covariates holds the information required to construct a covariates term in a prior for a main effect or interaction.

Slots

formula

An R formula.

data

A data.frame holding the covariate data.

contrastsArg

A named list of contrasts, as described in the documentation for model.matrix. #' @slot nuEtaCoef Degrees of freedom for the t priors for the coefficients.

AEtaCoef

Scale parameter for the t priors for the coefficients.

multEtaCoef

Multiplier for AEtaCoef.

Warning

In normal usage, it should not be necessary to access, or even know about, the slots of a Covariates object. The slots are not part of the API of the package, and may change in future.

See Also

Objects of class Covariates are created by a call to function Covariates.

StatisticsNZ/demest documentation built on Nov. 2, 2023, 7:56 p.m.