about_variable: About Varialbe

View source: R/ClusterModeling_modelfunctions.R

about_variableR Documentation

About Varialbe

Description

about_variable() returns information about the model variable.

Usage

about_variable(variable, model)

Arguments

variable

A variable in the fitted model output by fit_model()

model

A fitted model created by fit_model()

Value

Text that explains the variable

Examples

about_variable(
  variable = "mu[1,2]",
  model = example_model_1chain
)
about_variable(
  variable = "gamma[5]",
  model = example_model_2chains
)


handwriter documentation built on Oct. 13, 2023, 5:10 p.m.