R/install.R
install_cmdstan.Rd
The install_cmdstan()
function attempts to download and
install the latest release of CmdStan.
Installing a previous release or a new release candidate is also possible
by specifying the version
or release_url
argument.
See the first few sections of the CmdStan
installation guide
for details on the C++ toolchain required for installing CmdStan.
The rebuild_cmdstan()
function cleans and rebuilds the CmdStan
installation. Use this function in case of any issues when compiling models.
The cmdstan_make_local()
function is used to read/write makefile flags
and variables from/to the make/local
file of a CmdStan installation.
Writing to the make/local
file can be used to permanently add makefile
flags/variables to an installation. For example adding specific compiler
switches, changing the C++ compiler, etc. A change to the make/local
file
should typically be followed by calling rebuild_cmdstan()
.
The check_cmdstan_toolchain()
function attempts to check for the required
C++ toolchain. It is called internally by install_cmdstan()
but can also
be called directly by the user.
install_cmdstan( dir = NULL, cores = getOption("mc.cores", 2), quiet = FALSE, overwrite = FALSE, timeout = 1200, version = NULL, release_url = NULL, cpp_options = list(), check_toolchain = TRUE ) rebuild_cmdstan( dir = cmdstan_path(), cores = getOption("mc.cores", 2), quiet = FALSE, timeout = 600 ) cmdstan_make_local(dir = cmdstan_path(), cpp_options = NULL, append = TRUE) check_cmdstan_toolchain(fix = FALSE, quiet = FALSE)
dir | (string) The path to the directory in which to install CmdStan.
The default is to install it in a directory called |
---|---|
cores | (integer) The number of CPU cores to use to parallelize building
CmdStan and speed up installation. If |
quiet | (logical) For |
overwrite | (logical) Should CmdStan still be downloaded and installed
even if an installation of the same version is found in |
timeout | (positive real) Timeout (in seconds) for the build stage of the installation. |
version | (string) The CmdStan release version to install. The default
is |
release_url | (string) The URL for the specific CmdStan release or
release candidate to install. See https://github.com/stan-dev/cmdstan/releases.
The URL should point to the tarball ( |
cpp_options | (list) Any makefile flags/variables to be written to
the |
check_toolchain | (logical) Should |
append | (logical) For |
fix | For |
For cmdstan_make_local()
, if cpp_options=NULL
then the existing
contents of make/local
are returned without writing anything, otherwise
the updated contents are returned.
# \dontrun{ check_cmdstan_toolchain()#># install_cmdstan(cores = 4) cpp_options <- list( "CXX" = "clang++", "CXXFLAGS+= -march=native", PRECOMPILED_HEADERS = TRUE ) # cmdstan_make_local(cpp_options = cpp_options) # rebuild_cmdstan() # }