File: registerPlugin.Rd

package info (click to toggle)
rcpp 1.1.1-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 6,224 kB
  • sloc: cpp: 27,429; ansic: 7,797; sh: 55; makefile: 2
file content (27 lines) | stat: -rw-r--r-- 695 bytes parent folder | download | duplicates (9)
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
\name{registerPlugin}
\alias{registerPlugin}
\title{
Register an inline plugin
}
\description{
Register an \link[inline:plugins]{inline plugin} for use with 
\code{\link{sourceCpp}} or \code{\link{cppFunction}}. Inline plugins are functions
that return a list with additional includes, environment variables, and
other compilation context. 
}
\usage{
registerPlugin(name, plugin)
}
\arguments{
    \item{name}{Name of the inline plugin}
    \item{plugin}{Inline plugin function}
}
\details{
    Plugins can be added to \code{\link{sourceCpp}} compilations using the
    \code{\link[=pluginsAttribute]{Rcpp::plugins}} attribute.
}
\seealso{
    \code{\link[=pluginsAttribute]{Rcpp::plugins}}
}