Skip to contents

Link a Conda environment binary to an R option

Source: R/link_conda_bin.R
linkCondaBin.Rd

This function checks that a specified binary exists within a Conda environment and then sets an R option pointing to it. By default, the option name is constructed as "phgv2_<bin>_path".

Usage

linkCondaBin(condaPath, envName = "phgv2-conda", bin = "agc", verbose = TRUE)

Arguments

condaPath

A character string for the Conda installation path.

envName

A character string for the environment name. Defaults to "phgv2-conda".

bin

A character string for the binary to link. Defaults to "agc".

verbose

A logical indicating whether to print a message after setting the option. Defaults to TRUE.

Value

The function returns nothing. It is called for its side effects, namely setting an R option and optionally printing a message.

Details

This function calls validateBinary to ensure the binary exists. Then it constructs an option name ("phgv2_<bin>_path") and sets its value to the binary's path. If verbose is TRUE, a status message is shown.

Examples

if (FALSE) { # \dontrun{
linkCondaBin("~/miniconda3", "phgv2-conda", "agc")
} # }