fit-method-cmdstan_summary: Run CmdStan's 'stansummary' and 'diagnose' utilities

fit-method-cmdstan_summaryR Documentation

Run CmdStan's stansummary and diagnose utilities

Description

Run CmdStan's stansummary and diagnose utilities. These are documented in the CmdStan Guide:

  • https://mc-stan.org/docs/cmdstan-guide/stansummary.html

  • https://mc-stan.org/docs/cmdstan-guide/diagnose.html

Although these methods can be used for models fit using the $variational() method, much of the output is currently only relevant for models fit using the $sample() method.

See the $summary() for computing similar summaries in R rather than calling CmdStan's utilites.

Usage

cmdstan_summary(flags = NULL)

cmdstan_diagnose()

Arguments

flags

An optional character vector of flags (e.g. flags = c("--sig_figs=1")).

See Also

CmdStanMCMC, fit-method-summary

Examples

## Not run: 
fit <- cmdstanr_example("logistic")
fit$cmdstan_diagnose()
fit$cmdstan_summary()

## End(Not run)


stan-dev/cmdstanr documentation built on April 26, 2024, 2:02 a.m.