diff --git a/DESCRIPTION b/DESCRIPTION index 36825ba09..1c82510f0 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: cmdstanr Title: R Interface to 'CmdStan' -Version: 0.5.2.1 +Version: 0.5.3 Date: 2022-04-24 Authors@R: c(person(given = "Jonah", family = "Gabry", role = c("aut", "cre"), @@ -27,7 +27,7 @@ URL: https://mc-stan.org/cmdstanr/, https://discourse.mc-stan.org BugReports: https://github.com/stan-dev/cmdstanr/issues Encoding: UTF-8 LazyData: true -RoxygenNote: 7.1.2 +RoxygenNote: 7.2.0 Roxygen: list(markdown = TRUE, r6 = FALSE) SystemRequirements: CmdStan (https://mc-stan.org/users/interfaces/cmdstan) Depends: diff --git a/NEWS.md b/NEWS.md index 33c256603..495c4d477 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,11 @@ -# cmdstanr 0.4.0.9000 +# cmdstanr 0.5.3 + +### New features + +* On Windows, users can now install and use CmdStan with WSL (Windows +Subsystem for Linux). Set `wsl=TRUE` in `install_cmdstan()` to install CmdStan +for use with WSL. This can offer significant speedups compared to native +Windows execution. (#677, @andrjohns) ### Bug fixes @@ -13,6 +20,9 @@ with spaces. (@weshinsley, #661, #663) * Fixed a bug that caused issues when using `~` or `.` in paths supplied to the `cmdstanr_write_stan_file_dir` global option. +* Fixed a bug that caused the `time()` method fail when some of the chains failed to finish +succesfully. + # cmdstanr 0.5.2 * Refactored toolchain installation and checks for R 4.x on Windows and added support diff --git a/R/model.R b/R/model.R index 5346346b9..5d73ae383 100644 --- a/R/model.R +++ b/R/model.R @@ -1159,6 +1159,7 @@ CmdStanModel$set("public", name = "sample", value = sample) #' processes. For example, `mpi_args = list("n" = 4)` launches the executable #' as `mpiexec -n 4 model_executable`, followed by CmdStan arguments for the #' model executable. +#' @param validate_csv Deprecated. Use `diagnostics` instead. #' #' @return A [`CmdStanMCMC`] object. #' diff --git a/man/cmdstan_default_path.Rd b/man/cmdstan_default_path.Rd index 560bbc3b1..36aab208c 100644 --- a/man/cmdstan_default_path.Rd +++ b/man/cmdstan_default_path.Rd @@ -19,4 +19,10 @@ version, or \code{NULL} if no installation found. Returns the path to the installation of CmdStan with the most recent release version. } +\details{ +For Windows systems with WSL CmdStan installs, if there are side-by-side WSL +and native installs with the same version then the WSL is preferred. +Otherwise, the most recent release is chosen, regardless of whether it is +native or WSL. +} \keyword{internal} diff --git a/man/model-method-sample_mpi.Rd b/man/model-method-sample_mpi.Rd index f6089528e..12dbc47e6 100644 --- a/man/model-method-sample_mpi.Rd +++ b/man/model-method-sample_mpi.Rd @@ -239,7 +239,7 @@ Diagnostics like R-hat and effective sample size are \emph{not} currently available via the \code{diagnostics} argument but can be checked after fitting using the \code{\link[=fit-method-summary]{$summary()}} method.} -\item{validate_csv}{Deprecated and will be removed in a future release.} +\item{validate_csv}{Deprecated. Use \code{diagnostics} instead.} } \value{ A \code{\link{CmdStanMCMC}} object. @@ -257,9 +257,11 @@ installed. For Unix systems the most commonly used implementations are MPICH and OpenMPI. The implementations provide an MPI C++ compiler wrapper (for example mpicxx), which is required to compile the model. -An example of compiling with MPI:\preformatted{mpi_options = list(STAN_MPI=TRUE, CXX="mpicxx", TBB_CXX_TYPE="gcc") +An example of compiling with MPI: + +\if{html}{\out{