model-method-variables: Input and output variables of a Stan program

In stan-dev/cmdstanr: R Interface to 'CmdStan'

Input and output variables of a Stan program

Description

The ⁠$variables()⁠ method of a CmdStanModel object returns a list, each element representing a Stan model block: data, parameters, transformed_parameters and generated_quantities.

Each element contains a list of variables, with each variables represented as a list with infromation on its scalar type (real or int) and number of dimensions.

⁠transformed data⁠ is not included, as variables in that block are not part of the model's input or output.

Usage

variables()

Value

The ⁠$variables()⁠ returns a list with information on input and output variables for each of the Stan model blocks.

See Also

Other CmdStanModel methods: model-method-check_syntax, model-method-compile, model-method-diagnose, model-method-expose_functions, model-method-format, model-method-generate-quantities, model-method-laplace, model-method-optimize, model-method-pathfinder, model-method-sample, model-method-sample_mpi, model-method-variational

Examples

## Not run: 
file <- file.path(cmdstan_path(), "examples/bernoulli/bernoulli.stan")

# create a `CmdStanModel` object, compiling the model is not required
mod <- cmdstan_model(file, compile = FALSE)

mod$variables()


## End(Not run)

stan-dev/cmdstanr documentation built on May 16, 2024, 12:58 a.m.