rapbase

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

Install rapbase from CRAN:

install.packages("rapbase")

The latest release of the package can be installed from GitHub:

remotes::install_github("Rapporteket/rapbase@*release")

Or install the development version from GitHub with:

remotes::install("Rapporteket/rapbase")

## Usage
Once the package is installed functions can be called from within R, *e.g.*:
```r
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

If you want to make changes to this project please follow the Contributing guide. Proposed changes will be processed based on manual code reviews. Code that is accepted will be merged into the main branch and used for full scale TESTING and QA prior to making a release for PRODUCTION deployment.

For kick-starting, a development environment set-up is included and may be applied if docker and docker-compose is at hand. After cloning rapbase the development environment can be startet from a terminal at the local work copy root directory by:

docker-compose up

Navigate a browser to localhost on port 8787, log in to the RStudio IDE and initiate the project by "clicking" the file rapbase.Rproj inside the rapbase directory. For development all suggested imports for the rapbase R package will be needed. To make sure these are installed use the R Console and run

devtools::install_dev_deps()

After installing has finished all should be set to start change-build-test iterations :rocket:

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.