predict.mvord {mvord}

Predict method for Multivariate Ordinal Regression Models.

Description

Obtains predicted or fitted values for objects of class 'mvord'.

Usage

## S3 method for class 'mvord'
predict(
  object,
  newdata = NULL,
  type = "prob",
  subjectID = NULL,
  newoffset = NULL,
  ...
)

Arguments

object

an object of class 'mvord'.

newdata

(optional) data frame of new covariates and new responses.

type

types "class", "prob" and "cum.prob" are available.

subjectID

(optional) vector specifying for which subjectIDs the predictions
or fitted values should be computed.

newoffset

(optional) list of length equal to the number of outcomes, each element containing a vector of offsets to be considered.

...

further arguments passed to or from other methods.

Details

type	description
"class"	combination of response categories with the highest probability.
"prob"	(default) fitted joint probability for the observed response categories
	or the categories provided in the response column(s) in newdata.
	If response column(s) in newdata contain only NAs, this will return a vector of ones.
"cum.prob"	fitted joint cumulative probability for the observed response
	categories or the categories provided in the response column(s) in newdata.
	If response column(s) in newdata contain only NAs, this will return a vector of ones.

The (row) names of the output correspond to the subjectIDs.

See Also

marginal_predict, joint_probabilities