clmstan (version 0.1.1)

fitted.clmstan: Fitted values for clmstan objects

Description

Returns expected category probabilities for each observation. This is equivalent to predict(object, type = "probs", summary = TRUE).

Usage

# S3 method for clmstan
fitted(
  object,
  newdata = NULL,
  summary = TRUE,
  robust = FALSE,
  probs = c(0.025, 0.975),
  ndraws = NULL,
  ...
)

Value

If summary = TRUE (default): A data frame with N rows and columns for each category probability (P[Y=1], P[Y=2], etc.). If summary = FALSE: An S x N x K array of probability draws.

Arguments

object

A clmstan object returned by clm_stan().

newdata

Optional data frame for prediction. If NULL (default), predictions are made for the original training data.

summary

Logical. If TRUE (default), return summary statistics (mean, SD, quantiles). If FALSE, return raw posterior draws.

robust

Logical. If TRUE, use median instead of mean for point estimates. Default is FALSE.

probs

Numeric vector of probabilities for quantiles. Default is c(0.025, 0.975) for 95% credible intervals.

ndraws

Number of posterior draws to use. If NULL (default), all available draws are used.

...

Additional arguments (currently ignored).

See Also

predict.clmstan(), posterior_predict.clmstan()