Title: | An 'Armadillo' Interface |
---|---|
Description: | Provides function declarations and inline function definitions that facilitate communication between R and the 'Armadillo' 'C++' library for linear algebra and scientific computing. This implementation is detailed in Vargas Sepulveda and Schneider Malamud (2024) <doi:10.48550/arXiv.2408.11074>. |
Authors: | Mauricio Vargas Sepulveda [aut, cre] , Jonathan Schneider Malamud [ctb], Conrad Sanderson [aut] (Armadillo library (C++)) |
Maintainer: | Mauricio Vargas Sepulveda <[email protected]> |
License: | Apache License (>= 2) |
Version: | 0.3.5 |
Built: | 2024-11-20 20:33:06 UTC |
Source: | https://github.com/pachadotdev/cpp11armadillo |
Provides the Armadillo C++ library version name and number included in the package.
armadillo_version()
armadillo_version()
A string with the Armadillo version name and number
armadillo_version()
armadillo_version()
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.
cpp_vendor(dir = NULL, subdir = "/inst/include")
cpp_vendor(dir = NULL, subdir = "/inst/include")
dir |
The directory to vendor the code into. |
subdir |
The subdirectory to vendor the code into. |
This function vendors cpp11 and cpp11armadillo into your package by copying the cpp11 and cpp11armadillo headers into the 'inst/include' folder and adding 'cpp11 version: XYZ' and 'cpp11armadillo version: XYZ' to the top of the files, where XYZ is the version of cpp11 and cpp11armadillo currently installed on your machine.
Vendoring places the responsibility of updating the code on you. Bugfixes and new features in cpp11 and cpp11armadillo will not be available for your code until you run 'cpp_vendor()' again.
The file path to the vendored code (invisibly).
# create a new directory dir <- tempdir() dir.create(dir) # vendor the cpp11 headers into the directory cpp_vendor(dir)
# create a new directory dir <- tempdir() dir.create(dir) # vendor the cpp11 headers into the directory cpp_vendor(dir)
Start a new project with the cpp11armadillo package template
pkg_template(path = NULL, pkgname = NULL)
pkg_template(path = NULL, pkgname = NULL)
path |
Path to the new project |
pkgname |
Name of the new package |
The file path to the copied template (invisibly).
# create a new directory dir <- tempdir() dir.create(dir) # copy the package template into the directory pkg_template(dir, "mynewpkg")
# create a new directory dir <- tempdir() dir.create(dir) # copy the package template into the directory pkg_template(dir, "mynewpkg")