Create a skeleton for a new package depending on RcppParallel
RcppParallel.package.skeleton automates the creation of a new source
package that intends to use features of RcppParallel.
RcppParallel.package.skeleton(name = "anRpackage", example_code = TRUE, ...)
name |
The name of your R package. |
example_code |
If |
... |
Optional arguments passed to Rcpp.package.skeleton. |
It is based on the package.skeleton function which it executes first.
In addition to Rcpp.package.skeleton :
The DESCRIPTION file gains an Imports line requesting that the package depends on RcppParallel and a LinkingTo line so that the package finds RcppParallel header files.
The NAMESPACE gains a useDynLib directive as well as an
importFrom(RcppParallel, evalCpp to ensure instantiation of
RcppParallel.
The src directory is created if it does not exists and a Makevars file is added setting the environment variables PKG_LIBS to accomodate the necessary flags to link with the RcppParallel library.
If the example_code argument is set to TRUE, example files
vector-sum.cpp is created in the src directory.
Rcpp::compileAttributes() is then called to generate
src/RcppExports.cpp and R/RcppExports.R. These files are given
as an example and should eventually by removed from the generated package.
Nothing, used for its side effects
Read the Writing R Extensions manual for more details.
Once you have created a source package you need to install it: see
the R Installation and Administration manual, INSTALL
and install.packages.
## Not run:
# simple package
RcppParallel.package.skeleton("foobar")
## End(Not run)Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.