Create a skeleton for a new package that intends to use RcppArmadillo

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

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

Usage

RcppArmadillo.package.skeleton(name = "anRpackage", list = character(),
  environment = .GlobalEnv, path = ".", force = FALSE,
  code_files = character(), example_code = TRUE, author = "Your Name",
        maintainer = if (missing(author)) "Your Name" else author,
        email = "your@email.com", githubuser = NA_character_,
        license = "GPL (>= 2)")

Arguments

name: See package.skeleton
list: See package.skeleton
environment: See package.skeleton
path: See package.skeleton
force: See package.skeleton
code_files: See package.skeleton
example_code: If TRUE, example c++ code using RcppArmadillo is added to the package
author: Author of the package.
maintainer: Maintainer of the package.
email: Email of the package maintainer.
githubuser: GitHub username for URL and BugReports, if present.
license: License of the package.

Details

In addition to package.skeleton :

The DESCRIPTION file gains a Depends line requesting that the package depends on Rcpp and RcppArmadillo and a LinkingTo line so that the package finds Rcpp and RcppArmadillo header files.

The NAMESPACE, if any, gains a useDynLib directive.

The src directory is created if it does not exists and a Makevars file is added setting the environment variable PKG_LIBS to accomodate the necessary flags to link with the Rcpp library.

If the example_code argument is set to TRUE, example files rcpparma_hello_world.h and rcpparma_hello_world.cpp are also created in the src. An R file rcpparma_hello_world.R is expanded in the R directory, the rcpparma_hello_world function defined in this files makes use of the C++ function rcpparma_hello_world defined in the C++ file. 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.

Examples

if (FALSE) { # \dontrun{
RcppArmadillo.package.skeleton( "foobar" )
} # }