rapbase

Build Status AppVeyor build status codecov.io Lifecycle: maturing

rapbase is an R package holding common R functions for Rapporteket which is a reporting service for Norwegian medical quality registries. Each registry at Rapporteket will have their content structured as R packages that are all found under the Rapporteket organization at GitHub. Such packages are likely to depend on the rapbase package.

Top-level information regarding Rapporteket is provided on a dedicated site (in Norwegian).

Install

As of July 2019 the rapbase R package is available from GitHub and can be installed from the R command prompt:

remotes::install("Rapporteket/rapbase")

Alternatively, the package source code can be cloned from GitHub and built locally.

Usage

Once the package is installed functions can be called from within R, e.g.:

rapbase::HalloRapporteket()

For a complete and updated view of the package documentation please consult the rapbase-site. Looking into how others have implemented rapbase for various registries is also an excellent way of learning the use of rapbase. In the rapRegTemplate package (in Norwegian) that provides a Shiny application template to be used for making registries there is some boiler plate code to aid start up. Please feel free to also contact the maintainers and authors directly.

Issues

Please provide any comments (e.g. on proposed enhancements, shortcomings, errors) through the issue tracker.

Contributing

Contributors submit their code by forking from the ‘rel’ branch and opening of pull request. Development workflow must apply unit testing of the code. In addition to automated testing proposed changes and additions to the rapbase code will be accepted (or rejected) based on manual code reviews. Code that is accepted will be merged into the ‘rel’ branch, tagged and used for full scale TESTING and QA prior to PRODUCTION deployment.

Ethics

Please note that the ‘rapbase’ project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.