RcppParallel.package.skeleton: Create a skeleton for a new package depending on RcppParallel

Description Usage Arguments Details Value References See Also Examples

Description

RcppParallel.package.skeleton automates the creation of a new source package that intends to use features of RcppParallel.

It is based on the package.skeleton function which it executes first.

Usage

1
2
3
4
5
RcppParallel.package.skeleton(
    name = "anRpackage",
    example_code = TRUE,
    ...
)

Arguments

name

The name of your R package.

example_code

If TRUE, example C++ code using RcppParallel is added to the package.

...

Optional arguments passed to Rcpp.package.skeleton.

Details

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.

Value

Nothing, used for its side effects

References

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.

See Also

package.skeleton

Examples

1
2
3
4
5
## Not run: 
# simple package
RcppParallel.package.skeleton( "foobar" )

## End(Not run)

Example output

Creating directories ...
Creating DESCRIPTION ...
Creating NAMESPACE ...
Creating Read-and-delete-me ...
Saving functions and data ...
Making help files ...
Done.
Further steps are described in './foobar/Read-and-delete-me'.

Adding Rcpp settings
 >> added Imports: Rcpp
 >> added LinkingTo: Rcpp
 >> added useDynLib directive to NAMESPACE
 >> added importFrom(Rcpp, evalCpp) directive to NAMESPACE
 >> created init.c for package registration

Adding RcppParallel settings
 >> added Imports: Rcpp (>= 1.0.1), RcppParallel (>= 4.4.2)
 >> added LinkingTo: Rcpp, RcppParallel
 >> added SystemRequirements: GNU make
 >> added importFrom(RcppParallel,RcppParallelLibs) directive to NAMESPACE
 >> added src/Makevars
 >> added src/Makevars.win
 >> added example file src/vector-sum.cpp
 >> added example documentation man/vector-sum.Rd
 >> compiled Rcpp attributes
[1] TRUE

RcppParallel documentation built on May 23, 2019, 1:03 a.m.