inst/extdata/README.md

In cpp11armadillo: An 'Armadillo' Interface

How to use cpp11armadillo?

Read the documentation

The basic examples should be enough to get you started.

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.

Additional documentation

1. Member functions and variables
2. Matrix, vector, cube and field classes
3. Generated vectors, matrices, and cubes
4. Functions of vectors, matrices, and cubes
5. Fitting regressions with Armadillo

For specific Econometrics examples, see the hansen package documentation.

cpp11armadillo documentation built on June 8, 2025, 9:40 p.m.