Merge pull request #929 from stan-dev/clarify-output_dir-doc

Clarify in doc that for MCMC `output_dir` contains one file per chain
stan-dev · Mar 14, 2024 · 3d95a90 · 3d95a90
2 parents 28329d7 + 7ea302f
commit 3d95a90
Show file tree

Hide file tree

Showing 9 changed files with 45 additions and 36 deletions.
diff --git a/man-roxygen/model-common-args.R b/man-roxygen/model-common-args.R
@@ -56,10 +56,11 @@
 #'   method.
 #'
 #' @param output_dir (string) A path to a directory where CmdStan should write
-#'   its output CSV files. For interactive use this can typically be left at
-#'   `NULL` (temporary directory) since CmdStanR makes the CmdStan output
-#'   (posterior draws and diagnostics) available in \R via methods of the fitted
-#'   model objects. The behavior of `output_dir` is as follows:
+#'   its output CSV files. For MCMC there will be one file per chain; for other
+#'   methods there will be a single file. For interactive use this can typically
+#'   be left at `NULL` (temporary directory) since CmdStanR makes the CmdStan
+#'   output (posterior draws and diagnostics) available in \R via methods of the
+#'   fitted model objects. The behavior of `output_dir` is as follows:
 #'   * If `NULL` (the default), then the CSV files are written to a temporary
 #'   directory and only saved permanently if the user calls one of the `$save_*`
 #'   methods of the fitted model object (e.g.,

diff --git a/man/model-method-diagnose.Rd b/man/model-method-diagnose.Rd
diff --git a/man/model-method-generate-quantities.Rd b/man/model-method-generate-quantities.Rd
diff --git a/man/model-method-laplace.Rd b/man/model-method-laplace.Rd
diff --git a/man/model-method-optimize.Rd b/man/model-method-optimize.Rd
diff --git a/man/model-method-pathfinder.Rd b/man/model-method-pathfinder.Rd
diff --git a/man/model-method-sample.Rd b/man/model-method-sample.Rd
diff --git a/man/model-method-sample_mpi.Rd b/man/model-method-sample_mpi.Rd
diff --git a/man/model-method-variational.Rd b/man/model-method-variational.Rd