[go: up one dir, main page]

File: loadRcppModules.Rd

package info (click to toggle)
rcpp 0.11.3-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 9,948 kB
  • ctags: 16,427
  • sloc: ansic: 42,692; cpp: 34,078; makefile: 32; sh: 21
file content (24 lines) | stat: -rw-r--r-- 725 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
\name{loadRcppModules}
\alias{loadRcppModules}
\title{
Loads Rcpp modules on package startup
}
\description{
Function to simplify loading Rcpp modules contained in a package. 
This function must be called from the \code{.onLoad} function of a package. 
It uses the \code{RcppModules} field of the package \code{DESCRIPTION} file
to query the names of the modules that the package should export, loads each module, 
and \code{\link{populate}} each module into the package NAMESPACE.
}
\usage{
loadRcppModules(direct=TRUE)
}
\arguments{
    \item{direct}{if \code{TRUE} the content of the module is exposed in the
    namespace. Otherwise, the module is exposed. }
}
\seealso{
    \code{\link{populate}}
}
\keyword{interface}