armadillo4r (version 0.7.0)

vendor: Vendor the cpp4r and armadillo4r headers

Description

Vendoring is the act of making your own copy of the 3rd party packages your project is using. It is often used in the go language community.

This function vendors armadillo4r into your package by copying the armadillo4r headers into the `inst/include` folder of your package and adding 'armadillo4r version: XYZ' to the top of the files, where XYZ is the version of armadillo4r currently installed on your machine.

**Note**: vendoring places the responsibility of updating the code on **you**. Bugfixes and new features in armadillo4r will not be available for your code until you run `cpp_vendor()` again.

Usage

vendor(path = NULL)

Value

The path to the vendored code (invisibly).

Arguments

path

The directory with the vendored headers. It is recommended to use `"./src/vendor"`. The default is `NULL`.

Examples

# create a new directory
dir <- paste0(tempdir(), "/", gsub("\\s+|[[:punct:]]", "", Sys.time()))
dir.create(dir, recursive = TRUE)

# vendor the armadillo4r headers into the directory
vendor(dir)

# just a preview as Armadillo has over 100 files
head(list.files(dir, recursive = TRUE))

# cleanup
unlink(dir, recursive = TRUE)