Package index • clmstan

Model Fitting

Main function for fitting cumulative link models

clm_stan(): Fit a Cumulative Link Model using CmdStanR
clmstan-class: clmstan S3 Class

Prior Specification

Functions for specifying prior distributions

prior(): Specify Prior Distributions
clm_prior(): Prior Specification for clmstan
normal(): Normal Distribution for Prior Specification
gamma(): Gamma Distribution for Prior Specification
student_t(): Student-t Distribution for Prior Specification
cauchy(): Cauchy Distribution for Prior Specification
flat(): Flat (Improper Uniform) Prior Distribution
c(<clm_prior_spec>): Combine Multiple Prior Specifications

Model Information

Query available options

supported_links(): Get supported link functions
supported_thresholds(): Get supported threshold structures
link_functions: Available Link Functions

S3 Methods

Methods for clmstan objects

coef(<clmstan>): Extract coefficients from clmstan objects
summary(<clmstan>): Summary method for clmstan objects
print(<clmstan>): Print method for clmstan objects
print(<summary.clmstan>): Print method for summary.clmstan objects
plot(<clmstan>): Plot method for clmstan objects

Prediction

Prediction functions

predict(<clmstan>): Predict method for clmstan objects
fitted(<clmstan>): Fitted values for clmstan objects
posterior_predict.clmstan(): Posterior predictive distribution for clmstan objects

Model Comparison

Leave-one-out cross-validation and WAIC

loo(<clmstan>): Leave-One-Out Cross-Validation for clmstan objects
waic(<clmstan>): Widely Applicable Information Criterion for clmstan objects

Diagnostics

MCMC convergence diagnostics

diagnostics(): MCMC Diagnostics for clmstan objects
extract_acf(): Extract ACF values from clmstan object

Utilities

Utility functions

is.clmstan(): Check if object is clmstan

Print Methods

Print methods for prior objects

print(<clm_dist>): Print method for clm_dist objects
print(<clm_prior>): Print method for clm_prior objects
print(<clm_prior_list>): Print method for clm_prior_list objects
print(<clm_prior_spec>): Print method for clm_prior_spec objects