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.


RcppProgress

Build Status codecov CRAN_Status_Badge

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

test on windows using rhub

make docker/run
make check_rhub_windows

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("RcppProgress")

0.4.2 by Karl Forner, 7 years ago


https://github.com/kforner/rcpp_progress


Report a bug at https://github.com/kforner/rcpp_progress/issues


Browse source code at https://github.com/cran/RcppProgress


Authors: Karl Forner <[email protected]>


Documentation:   PDF Manual  


GPL (>= 3) license


Suggests RcppArmadillo, devtools, roxygen2, testthat


Imported by APRScenario, Apoderoides, Ease, GCPM, SequenceSpikeSlab, bayesPO, bpvars, bsvarSIGNs, bsvars, bvars, cppRouting, epm, extrememix, fingerPro, hlt, kgrams, malan, matchingMarkets, moire, nQuack, polykde, poolfstat, purgeR, segregation, spatialrisk, textmineR, textreuse.

Depended on by IRTM, eyelinkReader, iglm.

Suggested by MatchIt, msde.

Linked to by ASV, AsyPeer, BGGM, BGVAR, CDatanet, CFC, DNAtools, EmiR, FLORAL, GPBayes, MCMCprecision, MSCquartets, NetworkInference, PSPI, PartialNetwork, RNewsflow, Racmacs, RcppPlanc, SANple, SBMTrees, Seurat, SpaTopic, WpProj, XOMultinom, adaptIVPT, bayesianVARs, baygel, bliss, clubpro, conos, corpustools, densityratio, desla, dfcomb, dfmta, disclapmix, dmbc, elgbd, fastpos, genepop, geometry, glmmrOptim, harmony, hibayes, jackalope, jrSiCKLSNMF, lddmm, matrixprofiler, mixedClust, multinomineq, mums2, mvMAPIT, oppr, ordinalClust, pagoda2, pompp, profoc, rMVP, rTLS, recosystem, redeem, remstats, rliger, robustmatrix, sanba, sccore, sentopics, shrinkDSM, shrinkTVP, shrinkTVPVAR, simer, smerc, sommer, spNetwork, spatialGE, stpphawkes, tidylda, uwot, word2vec.


See at CRAN