Configuring C Toolchain for Windows

R 4.3+

RTools43 Installation

Install RTools43 following the instructions here: https://cran.r-project.org/bin/windows/Rtools/rtools43/rtools.html

R 4.2

RTools42 Installation

Install RTools42 following the instructions here: https://cran.r-project.org/bin/windows/Rtools/rtools42/rtools.html

R4.0

Remove old RStan configuration

If you had previously installed RStan under 3.6 you may have some configuration files left over that will cause issues under R4.0.

The first thing to check is whether the BINPREF environment variable is pointing to the old RTools installation by running Sys.getenv("BINPREF").

You can skip to the next section if your output looks like the following:

Sys.getenv("BINPREF")
[1] ""

However, if your output looks like:

Sys.getenv("BINPREF")
[1] "C:/Rtools/mingw_$(WIN)/bin/"

Then you need to check whether your .Rprofile file has been configured to set this variable on R startup. If you run the following command and get the output:

readLines("~/.Rprofile")
[1] "Sys.setenv(BINPREF = "C:/Rtools/mingw_$(WIN)/bin/")"

Then you need to delete your .Rprofile file. You can get the location of this file by running:

file.path(Sys.getenv("HOME"), ".Rprofile")

Delete that file and then restart R. If BINPREF is no longer set, then you should get the following output:

Sys.getenv("BINPREF")
[1] ""

RTools4 Installation

The next step is to install RTools4 following the instructions here: https://cran.r-project.org/bin/windows/Rtools/rtools40.html

Make sure that you follow the instructions that put RTools on the path. Repeated here for clarity:

writeLines('PATH="${RTOOLS40_HOME}\\usr\\bin;${PATH}"', con = "~/.Renviron")

Then restart R and verify that RTools is being found via:

Sys.which("make")
## "C:\\rtools40\\usr\\bin\\make.exe"

And that you can install packages from source:

install.packages("jsonlite", type = "source")

R 3.6

Install RTools

The first step is to install RTools3.5 from CRAN, also linked here: https://cran.r-project.org/bin/windows/Rtools/history.html

Next, we need to configure R to be able to find the installed toolchain. To do this, we need to add the RTools directory to the system PATH variable and set the BINPREF variable to point to the right compilers. We'll use the pkgbuild package to find the RTools installation directory (this is an RStan dependency, and so would have been installed regardless):

install.packages("pkgbuild")

rt_path = gsub("\\","/",pkgbuild::rtools_path(),fixed=T)
rt_bin = paste0(substr(rt_path,1,nchar(rt_path)-4),"/mingw_$(WIN)/bin/")
writeLines(paste0('PATH="',rt_path,';${PATH}"'), con = "~/.Renviron")
writeLines(paste0('Sys.setenv(BINPREF = "',rt_bin,'")'), con = "~/.Rprofile")

Then restart R and verify that the toolchain has been found by installing an R package from source:

install.packages("jsonlite",type="source")

Makevars Configuration

Now that the c++ toolchain has been configured, you can enable some compiler optimisations to speed up your models. To do this, you need to create a Makevars.win file in a .R folder in your home directory (commonly your Documents folder, but this may vary). You can create this from R by running:

dotR <- file.path(Sys.getenv("HOME"), ".R")
if (!file.exists(dotR)) dir.create(dotR)
M <- file.path(dotR, "Makevars.win")
if (!file.exists(M)) file.create(M)
cat("\n CXX17FLAGS += -mtune=native -O3 -mmmx -msse -msse2 -msse3 -mssse3 -msse4.1 -msse4.2",
    file = M, sep = "\n", append = FALSE)

However, if you have the withr package at a version greater than 2.2.0 then you may encounter the following error when running models:

Error in cleanup_makevar(old) : argument "RMU" is missing, with no default.

As such you need to manually install version 2.2.0 by running:

devtools::install_version("withr", version="2.2.0")

If you wish to install RStan from source, then go to here. Otherwise, return to the Getting Started page to install RStan normally.