File: py_function_wrapper.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 (31 lines) | stat: -rw-r--r-- 1,062 bytes parent folder | download | duplicates (3)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/wrapper.R
\name{py_function_wrapper}
\alias{py_function_wrapper}
\alias{py_function_docs}
\title{Scaffold R wrappers for Python functions}
\usage{
py_function_wrapper(python_function, r_prefix = NULL, r_function = NULL)

py_function_docs(python_function)
}
\arguments{
\item{python_function}{Fully qualified name of Python function or class
constructor (e.g. \code{tf$layers$average_pooling1d})}

\item{r_prefix}{Prefix to add to generated R function name}

\item{r_function}{Name of R function to generate (defaults to name of Python
function if not specified)}
}
\description{
Scaffold R wrappers for Python functions
}
\note{
The generated wrapper will often require additional editing (e.g. to
convert Python list literals in the docs to R lists, to massage R numeric
values to Python integers via \code{as.integer} where required, etc.) so is
really intended as an starting point for an R wrapper rather than a wrapper
that can be used without modification.
}
\keyword{internal}