`slim_setup()` will attempt to determine the user's OS and install SLiM automatically. Note that on Windows, this will attempt to download a precompiled executable.

slim_setup(
  method = c("conda", "binary"),
  verbose = TRUE,
  force = FALSE,
  install_path = default_install_path(),
  conda_env = "slimr-conda"
)

Arguments

method

The method to use to install SLiM. Currently, only "conda" and "binary" are supported. If "conda", then SLiM will be installed via conda using the reticulate package. If "binary", then SLiM will be downloaded as a precompiled executable, which is currently only available on Windows.

verbose

Whether to print out progress of the installation.

force

If FALSE (the default) slim_setup will not install SLiM if it is already installed and can be found. If you want to force an installation, even if SLiM is already installed (perhaps to install a newer version), then use force=TRUE.

install_path

If method="binary", then this is the path to install the SLiM executable. If you do not use the default path, then you will need to set the SLIM_PATH environment variable so that slimr can find it.

conda_env

If method="conda", then this is the name of the conda environment to install SLiM into. If you do not use the default name, then it may take longer for slimr to find SLiM (which may increase loading times for the library).

Examples

if(interactive()) {
  slim_setup()
}