clarify difference between temp dir and user specified dir

stan-dev · Apr 18, 2024 · a89b46c · a89b46c
1 parent 9ef1543
commit a89b46c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/R/options.R b/R/options.R
@@ -22,7 +22,9 @@
 #' CmdStan be disabled? The default is `FALSE`.
 #'
 #' * `cmdstanr_output_dir`: The directory where CmdStan should write its output
-#' CSV files when fitting models. The default is a temporary directory.
+#' 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.
 #'
 #' * `cmdstanr_verbose`: Should more information be printed
 #' when compiling or running models, including showing how CmdStan was called
@@ -32,7 +34,9 @@
 #' 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.
+#' 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

diff --git a/man/cmdstanr_global_options.Rd b/man/cmdstanr_global_options.Rd