An Interruptible Progress Bar with OpenMP Support for C++ in R Packages

Allows to display a progress bar in the R console for long running computations taking place in c++ code, and support for interrupting those computations even in multithreaded code, typically using OpenMP.

a R package that provides a c++ interruptible progress bar with OpenMP support for c++ code in R packages

example

see a detailed example on Rcpp Gallery: http://gallery.rcpp.org/articles/using-rcppprogress/

How to build

Prerequisites:

OpenMP support to use the multithreaded parallelized version. OpenMP is available in GCC >= 4.2

Just install it the usual way.

If you want more control, unarchive it, cd to the source directory, then type R CMD INSTALL . in the console.

Contribute

Send me a pull request with at least one test or example

For developers

tests and check

If you have all the RcppProgress dependencies (and suggests) installed:

type:

make tests: to run the tests
make check: to check the package

docker-checker

A Dockerfile (<docker_checker/Dockerfile>) is provided to help building the dev environment (built on rocker/r-devel) in which to develop and test RcppProgress.

type:

make docker/build: to build the docker
make docker/run: to run a shell in the docker with the current dir mounted inside
make docker/check: to check the package inside the docker
make docker/tests: to run test tests of the package inside the docker