yaml_to_env: Create conda env from yaml file

View source: R/yaml_to_env.R

yaml_to_envR Documentation

Create conda env from yaml file

Description

Create a conda environment from a yaml file. By default, creates the "echoR" conda env to support echolocatoR.

Usage

yaml_to_env(
  yaml_path = system.file(package = "echoconda", "conda", "echoR_mini.yml"),
  method = c("basilisk", "reticulate"),
  conda = "auto",
  force_new = FALSE,
  show_contents = FALSE,
  verbose = TRUE,
  ...
)

Arguments

yaml_path

Path to local or remote yaml file with conda build specifications.

method

Method to use to create the conda env:

  • "basilisk" : Uses the R package basilisk.

  • "reticulate" : Uses the R package reticulate.

  • "cli" : Uses a custom wrapper for conda's command line interface.

conda

The path to a conda executable. Use "auto" to allow reticulate to automatically find an appropriate conda binary. See Finding Conda and conda_binary() for more details.

force_new

If the conda env already exists, overwrite it with a new one (DEFAULT: FALSE).

show_contents

Show the contents of the yaml file (if used).

verbose

Print messages.

...

Additional arguments passed to method-specific conda env build functions:

  • basilisk: create_env_basilisk

  • reticulate: conda_create

  • cli: create_env_cli

Source

GitHub Issue

StackOverflow suggestions for cross-platform troubleshooting

See Also

Other conda: activate_env(), env_to_yaml(), find_env_rlib()

Examples

conda_env <- yaml_to_env()

RajLabMSSM/echoconda documentation built on June 6, 2024, 10:38 a.m.