File: py_run.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 (38 lines) | stat: -rw-r--r-- 1,354 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/python.R
\name{py_run}
\alias{py_run}
\alias{py_run_string}
\alias{py_run_file}
\title{Run Python code}
\usage{
py_run_string(code, local = FALSE, convert = TRUE)

py_run_file(file, local = FALSE, convert = TRUE, prepend_path = TRUE)
}
\arguments{
\item{code}{The Python code to be executed.}

\item{local}{Boolean; should Python objects be created as part of
a local / private dictionary? If \code{FALSE}, objects will be created within
the scope of the Python main module.}

\item{convert}{Boolean; should Python objects be automatically converted
to their \R equivalent? If set to \code{FALSE}, you can still manually convert
Python objects to \R via the \code{\link[=py_to_r]{py_to_r()}} function.}

\item{file}{The Python script to be executed.}

\item{prepend_path}{Boolean; should the script directory be added to the
Python module search path? The default, \code{TRUE}, matches the behavior of
\verb{python <path/to/script.py>} at the command line.}
}
\value{
A Python dictionary of objects. When \code{local} is \code{FALSE}, this
dictionary captures the state of the Python main module after running
the provided code. Otherwise, only the variables defined and used are
captured.
}
\description{
Execute code within the scope of the \code{__main__} Python module.
}