inst/extdata/README.md

In armadillo4r: An 'Armadillo' Interface

How to use armadillo4r?

Read the documentation

The package website covers the basics, setup customization, and advanced use cases.

Test the package

1. Open ./dev/01_load_or_install.R and run it.
2. Open ./src/01_ols.cpp, inspect the OLS functions.
3. Create your own functions in ./02_your_functions.cpp.
4. Run devtools::load_all() before testing your functions, and then add tests to ./dev/02_test.R and run it.
5. Run ./dev/03_readme_and_license.R to add a README and license.
6. Run devtools::install() in ./dev/01_load_or_install.R to install the package locally when you are ready.
7. The package template includes a configuration with a predefined number of cores to use. You can change this value by doing this:

Unix: Edit ./src/Makevars.in to set DARMA_OPENMP_THREADS to another value or edit ./configure to change PKG_NCORES to another value.

Windows: Edit ./src/Makevars.win to set DARMA_OPENMP_THREADS to another value.

armadillo4r documentation built on Nov. 5, 2025, 6:23 p.m.