File: py_list_packages.Rd

package info (click to toggle)
r-cran-reticulate 1.41.0.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,088 kB
  • sloc: cpp: 5,154; python: 620; sh: 13; makefile: 2
file content (43 lines) | stat: -rw-r--r-- 1,352 bytes parent folder | download | duplicates (2)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/install.R
\name{py_list_packages}
\alias{py_list_packages}
\title{List installed Python packages}
\usage{
py_list_packages(
  envname = NULL,
  type = c("auto", "virtualenv", "conda"),
  python = NULL
)
}
\arguments{
\item{envname}{The name of, or path to, a Python virtual environment.
Ignored when \code{python} is non-\code{NULL}.}

\item{type}{The virtual environment type. Useful if you have both
virtual environments and Conda environments of the same name on
your system, and you need to disambiguate them.}

\item{python}{The path to a Python executable.}
}
\value{
An \R data.frame, with columns:

\describe{
\item{\code{package}}{The package name.}
\item{\code{version}}{The package version.}
\item{\code{requirement}}{The package requirement.}
\item{\code{channel}}{(Conda only) The channel associated with this package.}
}
}
\description{
List the Python packages that are installed in the requested Python
environment.
}
\details{
When \code{envname} is \code{NULL}, \code{reticulate} will use the "default" version
of Python, as reported by \code{\link[=py_exe]{py_exe()}}. This implies that you
can call \code{py_list_packages()} without arguments in order to list
the installed Python packages in the version of Python currently
used by \code{reticulate}.
}