Skip to contents

CmdStanR global options

Source: R/options.R
cmdstanr_global_options.Rd

These options can be set via options() for an entire R session.

Details

  • cmdstanr_draws_format: Which format provided by the posterior package should be used when returning the posterior or approximate posterior draws? The default depends on the model fitting method. See draws for more details.

  • cmdstanr_force_recompile: Should the default be to recompile models even if there were no Stan code changes since last compiled? See cmdstan_model() for more details. The default is FALSE. The option has no effect on a model created from an executable alone, which is never recompiled.

  • cmdstanr_max_rows: The maximum number of rows of output to print when using the $print() method. The default is 10.

  • cmdstanr_print_line_numbers: Should line numbers be included when printing a Stan program? The default is FALSE.

  • cmdstanr_no_ver_check: Should the check for a more recent version of CmdStan be disabled? The default is FALSE. Alternatively, set the cmdstanr_no_ver_check environment variable to "true" (case-insensitive). Configure the option or environment variable before attaching the package.

  • cmdstanr_output_dir: The directory where CmdStan should write its output CSV files when fitting models. The default is a temporary directory. Files in a temporary directory are removed as part of R garbage collection, while files in an explicitly defined directory are not automatically deleted. A cached Quarto or R Markdown render keeps the fit object but not the files in a temporary directory, so set this option (or pass output_dir) when caching chunks that fit models.

  • cmdstanr_compress: Compression for the output CSV files when fitting models: "none", "gzip", or "bzip2". The default is "none".

  • cmdstanr_progress_bar: Should $sample() and $sample_mpi() show a progress bar? The default is FALSE. See the show_progress_bar argument of $sample().

  • cmdstanr_spinner: Should a spinner be shown while CmdStan compiles a model, checks syntax, or is installed or rebuilt? The default is TRUE. The spinner is only ever shown in interactive sessions, so setting this to FALSE is only necessary to suppress it in an interactive session.

  • cmdstanr_verbose: Should more information be printed when compiling or running models, including showing how CmdStan was called internally? The default is FALSE.

  • cmdstanr_warn_inits: Should a warning be thrown if initial values are only provided for a subset of parameters? The default is TRUE.

  • cmdstanr_write_stan_file_dir: The directory where write_stan_file() should write Stan files. The default is a temporary directory. Files in a temporary directory are removed as part of R garbage collection, while files in an explicitly defined directory are not automatically deleted.

  • mc.cores: The number of cores to use for various parallelization tasks (e.g. running MCMC chains, installing CmdStan). The default depends on the use case and is documented with the methods that make use of mc.cores.

  • cmdstanr_save_metric: Should the adapted metric be saved to a separate JSON file when running MCMC? The default is FALSE.

  • cmdstanr_save_config: Should a JSON file be saved containing the argument tree and extra information when running CmdStan? The default is FALSE.

See also

cmdstan_model(), install_cmdstan(), and write_stan_file()