Skip to content

Commit 3f09369

Browse files
committed
Update documentation for CMDSTANR_USE_MSYS_TOOLCHAIN
1 parent e540183 commit 3f09369

4 files changed

Lines changed: 27 additions & 4 deletions

File tree

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ URL: https://mc-stan.org/cmdstanr/, https://discourse.mc-stan.org
3232
BugReports: https://github.com/stan-dev/cmdstanr/issues
3333
Encoding: UTF-8
3434
LazyData: true
35-
RoxygenNote: 7.3.1
35+
RoxygenNote: 7.3.2
3636
Roxygen: list(markdown = TRUE, r6 = FALSE)
3737
SystemRequirements: CmdStan (https://mc-stan.org/users/interfaces/cmdstan)
3838
Depends:

R/install.R

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,19 @@
2020
#'
2121
#' The `check_cmdstan_toolchain()` function attempts to check for the required
2222
#' C++ toolchain. It is called internally by `install_cmdstan()` but can also
23-
#' be called directly by the user.
23+
#' be called directly by the user. On Windows only, calling the function with
24+
#' the `fix = TRUE` argument will attempt to install the necessary toolchain
25+
#' components if they are not found. For Windows users with RTools44 no additional
26+
#' toolchain configuration is required. For users with older versions of RTools,
27+
#' the function will install `mingw32-make` and `g++` from MSYS using the
28+
#' RTools-provided `pacman` package manager. This can also be manually requested
29+
#' by setting the environment variable `CMDSTANR_USE_MSYS_TOOLCHAIN` to 'true'
2430
#'
31+
#' NOTE: When installing CmdStan on Windows with RTools44 and CmdStan versions
32+
#' prior to 2.35.0, the above additional toolchain configuration
33+
#' is still required. To enable this configuration, set the environment variable
34+
#' `CMDSTANR_USE_MSYS_TOOLCHAIN` to 'true' and call
35+
#' `check_cmdstan_toolchain(fix = TRUE)`.
2536
#'
2637
#' @export
2738
#' @param dir (string) The path to the directory in which to install CmdStan.

man/fit-method-save_object.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/install_cmdstan.Rd

Lines changed: 13 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)