Update documentation of dots in stan_sampling_opts() (#699)

jamesmbaazam · web-flow · commit 35409a6f7841 · 2024-07-02T14:30:26.000+01:00
* Dots are only passed to rstan sampling here

* Fix function hyperlink

* Update dots docs to include cmdstanr sample function

* Add NEWS

* Add reviewer and PR number
diff --git a/NEWS.md b/NEWS.md
@@ -4,6 +4,10 @@
 
 - `epinow()` now returns the "timing" output in a "time difference"" format that is easier to understand and work with. By @jamesmbaazam in #688 and reviewed by @sbfnk.
 
+## Documentation
+
+- Updated the documentation of the dots argument of the `stan_sampling_opts()` to add that the dots are passed to `cmdstanr::sample()`. By @jamesmbaazam in #699 and reviewed by @sbfnk.
+
 # EpiNow2 1.5.2
 
 A patch release to further fix an issue with the date in the package citation. This has now been addressed by removing `inst/CITATION`.
diff --git a/R/deprecated.R b/R/deprecated.R
@@ -386,6 +386,7 @@ get_incubation_period <- function(disease, source, max_value = 14,
 #'
 #' @description `r lifecycle::badge("deprecated")`
 #' Deprecated; use [stan_sampling_opts()] instead.
+#' @param ... Additional parameters to pass to [rstan::sampling()].
 #' @inheritParams stan_sampling_opts
 #' @return A list of arguments to pass to [rstan::sampling()].
 #' @export
diff --git a/R/opts.R b/R/opts.R
@@ -606,10 +606,11 @@ obs_opts <- function(family = c("negbin", "poisson"),
 #'
 #' @inheritParams stan_opts
 #'
-#' @param ... Additional parameters to pass to [rstan::sampling()].
+#' @param ... Additional parameters to pass to [rstan::sampling()] or
+#' [cmdstanr::sample()].
 #' @importFrom utils modifyList
 #' @return A list of arguments to pass to [rstan::sampling()] or
-#' [cmdstanr::sample().
+#' [cmdstanr::sample()].
 #' @export
 #' @examples
 #' stan_sampling_opts(samples = 2000)
diff --git a/man/stan_sampling_opts.Rd b/man/stan_sampling_opts.Rd
