RcppProgress v0.4.1

0

Monthly downloads

0th

Percentile

by Karl Forner

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.

Readme

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 () 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

Functions in RcppProgress

Name Description
RcppProgress-package An interruptible progress bar with OpenMP support for c++ in R packages
No Results!

Last month downloads

Details

License GPL (>= 3)
Type Package
LazyLoad yes
URL https://github.com/kforner/rcpp_progress
BugReports https://github.com/kforner/rcpp_progress/issues
Date 2018-05-11
RoxygenNote 6.0.1
NeedsCompilation no
Packaged 2018-05-11 13:15:30 UTC; karl
Repository CRAN
Date/Publication 2018-05-11 14:46:14 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/RcppProgress)](http://www.rdocumentation.org/packages/RcppProgress)