1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/conda.R
\name{conda-tools}
\alias{conda-tools}
\alias{conda_list}
\alias{conda_create}
\alias{conda_clone}
\alias{conda_export}
\alias{conda_remove}
\alias{conda_install}
\alias{conda_binary}
\alias{conda_exe}
\alias{conda_version}
\alias{conda_update}
\alias{conda_python}
\alias{conda_search}
\alias{condaenv_exists}
\title{Conda Tools}
\usage{
conda_list(conda = "auto")
conda_create(
envname = NULL,
packages = NULL,
...,
forge = TRUE,
channel = character(),
environment = NULL,
conda = "auto",
python_version = miniconda_python_version(),
additional_create_args = character()
)
conda_clone(envname, ..., clone = "base", conda = "auto")
conda_export(
envname,
file = if (json) "environment.json" else "environment.yml",
json = FALSE,
...,
conda = "auto"
)
conda_remove(envname, packages = NULL, conda = "auto")
conda_install(
envname = NULL,
packages,
forge = TRUE,
channel = character(),
pip = FALSE,
pip_options = character(),
pip_ignore_installed = FALSE,
conda = "auto",
python_version = NULL,
additional_create_args = character(),
additional_install_args = character(),
...
)
conda_binary(conda = "auto")
conda_exe(conda = "auto")
conda_version(conda = "auto")
conda_update(conda = "auto")
conda_python(envname = NULL, conda = "auto", all = FALSE)
conda_search(
matchspec,
forge = TRUE,
channel = character(),
conda = "auto",
...
)
condaenv_exists(envname = NULL, conda = "auto")
}
\arguments{
\item{conda}{The path to a \code{conda} executable. Use \code{"auto"} to allow
\code{reticulate} to automatically find an appropriate \code{conda} binary.
See \strong{Finding Conda} and \code{\link[=conda_binary]{conda_binary()}} for more details.}
\item{envname}{The name of, or path to, a conda environment.}
\item{packages}{A character vector, indicating package names which should be
installed or removed. Use \verb{<package>==<version>} to request the installation
of a specific version of a package. A \code{NULL} value for \code{\link[=conda_remove]{conda_remove()}}
will be interpretted to \code{"--all"}, removing the entire environment.}
\item{...}{Optional arguments, reserved for future expansion.}
\item{forge}{Boolean; include the \href{https://conda-forge.org/}{conda-forge}
repository?}
\item{channel}{An optional character vector of conda channels to include.
When specified, the \code{forge} argument is ignored. If you need to
specify multiple channels, including the conda forge, you can use
\verb{c("conda-forge", <other channels>)}.}
\item{environment}{The path to an environment definition, generated via
(for example) \code{\link[=conda_export]{conda_export()}}, or via \verb{conda env export}. When provided,
the conda environment will be created using this environment definition,
and other arguments will be ignored.}
\item{python_version}{The version of Python to be installed. Set this if
you'd like to change the version of Python associated with a particular
conda environment.}
\item{additional_create_args}{An optional character vector of additional
arguments to use in the call to \verb{conda create}.}
\item{clone}{The name of the conda environment to be cloned.}
\item{file}{The path where the conda environment definition will be written.}
\item{json}{Boolean; should the environment definition be written as JSON?
By default, conda exports environments as YAML.}
\item{pip}{Boolean; use \code{pip} for package installation? By default, packages
are installed from the active conda channels.}
\item{pip_options}{An optional character vector of additional command line
arguments to be passed to \code{pip}. Only relevant when \code{pip = TRUE}.}
\item{pip_ignore_installed}{Ignore already-installed versions when using pip?
(defaults to \code{FALSE}). Set this to \code{TRUE} so that specific package versions
can be installed even if they are downgrades. The \code{FALSE} option is useful
for situations where you don't want a pip install to attempt an overwrite of
a conda binary package (e.g. SciPy on Windows which is very difficult to
install via pip due to compilation requirements).}
\item{additional_install_args}{An optional character vector of additional
arguments to use in the call to \verb{conda install}.}
\item{all}{Boolean; report all instances of Python found?}
\item{matchspec}{A conda MatchSpec query string.}
}
\value{
\code{conda_list()} returns an \R \code{data.frame}, with \code{name} giving the name of
the associated environment, and \code{python} giving the path to the Python
binary associated with that environment.
\code{conda_create()} returns the path to the Python binary associated with the
newly-created conda environment.
\code{conda_clone()} returns the path to Python within the newly-created
conda environment.
\code{conda_export()} returns the path to the exported environment definition,
invisibly.
\code{conda_search()} returns an \R \code{data.frame} describing packages that
matched against \code{matchspec}. The data frame will usually include
fields \code{name} giving the package name, \code{version} giving the package
version, \code{build} giving the package build, and \code{channel} giving the
channel the package is hosted on.
}
\description{
Tools for managing Python \code{conda} environments.
}
\section{Finding Conda}{
Most of \code{reticulate}'s conda APIs accept a \code{conda} parameter, used to control
the \code{conda} binary used in their operation. When \code{conda = "auto"},
\code{reticulate} will attempt to automatically find a conda installation.
The following locations are searched, in order:
\enumerate{
\item The location specified by the \code{reticulate.conda_binary} \R option,
\item The location specified by the \code{RETICULATE_CONDA} environment variable,
\item The \code{\link[=miniconda_path]{miniconda_path()}} location (if it exists),
\item The program \code{PATH},
\item A set of pre-defined locations where conda is typically installed.
}
To force \code{reticulate} to use a particular \code{conda} binary, we recommend
setting:
\if{html}{\out{<div class="sourceCode r">}}\preformatted{options(reticulate.conda_binary = "/path/to/conda")
}\if{html}{\out{</div>}}
This can be useful if your conda installation lives in a location that
\code{reticulate} is unable to automatically discover.
}
\seealso{
\code{\link[=conda_run2]{conda_run2()}}
}
|
