summaryrefslogtreecommitdiffstats
path: root/src/arrow/r/man/install_pyarrow.Rd
diff options
context:
space:
mode:
Diffstat (limited to 'src/arrow/r/man/install_pyarrow.Rd')
-rw-r--r--src/arrow/r/man/install_pyarrow.Rd22
1 files changed, 22 insertions, 0 deletions
diff --git a/src/arrow/r/man/install_pyarrow.Rd b/src/arrow/r/man/install_pyarrow.Rd
new file mode 100644
index 000000000..223a26754
--- /dev/null
+++ b/src/arrow/r/man/install_pyarrow.Rd
@@ -0,0 +1,22 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/python.R
+\name{install_pyarrow}
+\alias{install_pyarrow}
+\title{Install pyarrow for use with reticulate}
+\usage{
+install_pyarrow(envname = NULL, nightly = FALSE, ...)
+}
+\arguments{
+\item{envname}{The name or full path of the Python environment to install
+into. This can be a virtualenv or conda environment created by \code{reticulate}.
+See \code{reticulate::py_install()}.}
+
+\item{nightly}{logical: Should we install a development version of the
+package? Default is to use the official release version.}
+
+\item{...}{additional arguments passed to \code{reticulate::py_install()}.}
+}
+\description{
+\code{pyarrow} is the Python package for Apache Arrow. This function helps with
+installing it for use with \code{reticulate}.
+}