Merge pull request #1042 from stan-dev/save_object-doc-update

Mention vignette section on faster model saving for large models
stan-dev · Nov 20, 2024 · 4b80205 · 4b80205
2 parents 19e7af8 + 1a040bd
commit 4b80205
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/R/fit.R b/R/fit.R
@@ -108,6 +108,10 @@ CmdStanFit <- R6::R6Class(
 #'   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_](https://mc-stan.org/cmdstanr/articles/cmdstanr.html)
+#'   vignette for some suggestions on faster model saving for large models.
+#'
 #' @param file (string) Path where the file should be saved.
 #' @param ... Other arguments to pass to [base::saveRDS()] besides `object` and `file`.
 #'

diff --git a/man/fit-method-save_object.Rd b/man/fit-method-save_object.Rd