| Type: | Package |
| 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 derived from Vargas Sepulveda and Schneider Malamud (2024) <doi:10.1016/j.softx.2025.102087>. |
| Version: | 0.6.0 |
| Imports: | cpp4r |
| Suggests: | desc, mockery, testthat (≥ 3.0.0), withr |
| Depends: | R(≥ 3.5.0) |
| License: | Apache License (≥ 2) |
| BugReports: | https://github.com/pachadotdev/armadillo4r/issues |
| URL: | https://pacha.dev/armadillo4r/, https://github.com/pachadotdev/armadillo4r |
| RoxygenNote: | 7.3.3 |
| Encoding: | UTF-8 |
| Config/testthat/edition: | 3 |
| NeedsCompilation: | no |
| Packaged: | 2025-10-30 03:22:36 UTC; pacha |
| Author: | Mauricio Vargas Sepulveda
 [aut, cre],
Jonathan Schneider Malamud [ctb],
Conrad Sanderson [aut] (Armadillo library (C++)) |
| Maintainer: | Mauricio Vargas Sepulveda <m.vargas.sepulveda@gmail.com> |
| Repository: | CRAN |
| Date/Publication: | 2025-11-03 19:10:02 UTC |
armadillo4r: 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.1016/j.softx.2025.102087.
Author(s)
Maintainer: Mauricio Vargas Sepulveda m.vargas.sepulveda@gmail.com (ORCID)
Authors:
Conrad Sanderson (Armadillo library (C++))
Other contributors:
Jonathan Schneider Malamud [contributor]
See Also
Useful links:
Report bugs at https://github.com/pachadotdev/armadillo4r/issues
Get Armadillo version
Description
Provides the Armadillo C++ library version name and number included in the package.
Usage
armadillo_version()
Value
A string with the Armadillo version name and number
Examples
armadillo_version()
Check that cpp4r can be used
Description
Check that cpp4r can be used
Usage
check_cpp4r()
Value
integer value
Start a new project with the armadillo4r package template
Description
Start a new project with the armadillo4r package template
Usage
pkg_template(path = NULL, pkgname = NULL)
Arguments
path |
Path to the new project |
pkgname |
Name of the new package |
Value
The file path to the copied template (invisibly).
Examples
# create a new directory
dir <- tempdir()
dir.create(dir)
# copy the package template into the directory
pkg_template(dir, "mynewpkg")
Unvendor the armadillo4r headers
Description
This function removes the vendored armadillo4r headers from your package by automatically finding the vendored headers.
Usage
unvendor(path = NULL)
Arguments
path |
The directory with the vendored headers. It is recommended to use '"./src/vendor"'. The default is 'NULL'. |
Value
The path to the unvendored code (invisibly).
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)
# unvendor the armadillo4r headers from the directory
unvendor(dir)
# cleanup
unlink(dir, recursive = TRUE)
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)
Arguments
path |
The directory with the vendored headers. It is recommended to use '"./src/vendor"'. The default is 'NULL'. |
Value
The path to the vendored code (invisibly).
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)