stan_cmdstan_exists {instantiate} | R Documentation |
Check if instantiate
can find CmdStanR and CmdStan.
Description
Check if instantiate
can find CmdStanR and CmdStan.
Usage
stan_cmdstan_exists(
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
TRUE
if instantiate
can find the CmdStanR R package and the
CmdStan command line tool. Returns FALSE
otherwise.
See Also
Other cmdstan:
stan_cmdstan_version()
Examples
stan_cmdstan_exists()
[Package
instantiate version 0.2.3
Index]