stan_cmdstan_path {instantiate} | R Documentation |
Path to CmdStan for instantiate
Description
Return the directory path to CmdStan that the instantiate
package uses.
Usage
stan_cmdstan_path(cmdstan_install = Sys.getenv("CMDSTAN_INSTALL", unset = ""))
Arguments
cmdstan_install |
Character of length 1, how to look for an installed
copy of CmdStan. See https://wlandau.github.io/instantiate/ for details.
Choices:
-
"" (default): look at the original value that the CMDSTAN_INSTALL
environment variable contained when instantiate at the time
when it was installed.
If it was "implicit" or "fixed" , then choose
the corresponding option below. Otherwise, default to "implicit" .
-
"implicit" : Let the cmdstanr::cmdstan_path() decide where
to look for CmdStan. As explained in the cmdstanr documentation,
the output of cmdstanr::cmdstan_path() depends
on the current value of the CMDSTAN environment variable.
The cmdstanr package must be installed. If it
is not installed, then stan_cmdstan_path()
returns the empty string "" .
-
"fixed" : Use the path to CmdStan that was originally
contained in Sys.getenv("CMDSTAN") at the time when instantiate
was installed.
|
Value
Character of length 1, directory path to CmdStan. The path
may or may not exist. Returns the empty string ""
if the path
cannot be determined.
See Also
Other packages:
stan_package_clean()
,
stan_package_compile()
,
stan_package_configure()
,
stan_package_model_files()
Examples
stan_cmdstan_path()
[Package
instantiate version 0.2.3
Index]