fit-method-save_object: Save fitted model object to a file

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

Save fitted model object to a file

Description

This method is a wrapper around base::saveRDS() that ensures that all posterior draws and diagnostics are saved when saving a fitted model object. Because the contents of the CmdStan output CSV files are only read into R lazily (i.e., as needed), the ⁠$save_object()⁠ method is the safest way to guarantee that everything has been read in before saving.

See the "Saving fitted model objects" section of the Getting started with CmdStanR vignette for some suggestions on faster model saving for large models.

Usage

save_object(file, ...)

Arguments

file	(string) Path where the file should be saved.
...	Other arguments to pass to base::saveRDS() besides object and file.

See Also

CmdStanMCMC, CmdStanMLE, CmdStanVB, CmdStanGQ

Examples

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

temp_rds_file <- tempfile(fileext = ".RDS")
fit$save_object(file = temp_rds_file)
rm(fit)

fit <- readRDS(temp_rds_file)
fit$summary()

## End(Not run)

stan-dev/cmdstanr documentation built on April 12, 2025, 8:40 p.m.