buildPackage: Integrative function for building packages

Description Usage Arguments Details Examples

Description

Convenient way to compile, test or install a package

Usage

1
2
3
4
5
6
7
buildPackage(package, version = NULL, path = pathGitHub(),
  register.c.routine = FALSE, compile.attributes = TRUE,
  update.collate = FALSE, update.date = TRUE, roxygenise = TRUE,
  build = TRUE, options.build = NULL, untar = TRUE, check = FALSE,
  options.check = NULL, install = TRUE, options.install = "--build",
  trace = 2, clear.existing = TRUE, clear.r.check = TRUE,
  clear.install = TRUE)

Arguments

package

the name of the package

version

the version of the package

path

the position of the directory containing the package

register.c.routine

should the function package_native_routine_registration_skeleton be used to register C++ routines.

compile.attributes

should the function compile.attributes be used to enerates the bindings required to call C++ functions from R for functions adorned with the Rcpp::export attribute.

update.collate

should the collate field of the DESCRIPTION file be updated according the content of the R directory.

update.date

should the date field of the DESCRIPTION file be updated with the date of the date.

roxygenise

should the documentation be generated using roxygenise

build

should the package be build

options.build

additional options used to build the package

untar

should the package be unzipped

check

should the CRAN test be applied to the package

options.check

additional options used to check the package

install

should the package be installed on the computer.

options.install

additional options used to install the package

trace

How the execution of the function should be traced. If 2, also display the execution of compile.attributes.

clear.existing

should the existing directories containing the tests, the unziped package or the archive file be removed.

clear.r.check

Should the directory where the package has been tested be removed at the end of the execution.

clear.install

Should the directory where the package has been unzipped be removed at the end of the execution.

Details

Reminder [not related to the function] exportPattern("^[^\.]") : exporte toutes les fonctions ne commencant pas par un point exportPattern("^[[:alpha:]]+") : exporte toutes les fonctions commencant par une lettre

Examples

1
2
3
4
## Not run: 
buildPackage("butils")

## End(Not run)

bozenne/butils.base documentation built on May 13, 2019, 1:40 a.m.