diff --git a/README.md b/README.md index e5c7457..90c2602 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,93 @@ -# The `certetemplate` package for R +# The `???` package for R -[![certetemplate status badge](https://certe-medical-epidemiology.r-universe.dev/badges/certetemplate?color=01617e)](https://certe-medical-epidemiology.r-universe.dev) -[![codecov](https://codecov.io/gh/certe-medical-epidemiology/certetemplate/branch/main/graph/badge.svg)](https://codecov.io/gh/certe-medical-epidemiology/certetemplate) -[![R-CMD-check](https://github.com/certe-medical-epidemiology/certetemplate/actions/workflows/R-CMD-check.yaml/badge.svg?branch=main)](https://github.com/certe-medical-epidemiology/certetemplate/actions/workflows/R-CMD-check.yaml) -[![CodeFactor](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certetemplate/badge/main)](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certetemplate/overview/main) +This is a Certe R package for `[here the description]`. -The certetemplate R package +You can read the [manual with explanation about its functions here](https://certe-medical-epidemiology.github.io/???/reference). -### General Information -This is an R package developed by [**Certe**](https://www.certe.nl), a non-profit medical laboratory in the Northern Netherlands that provides routine diagnostic tests for clinical chemistry and clinical microbiology, as well as medical logistics and a thrombosis service. Their department of Medical Epidemiology, which developed this R package, conducts (and develops new methods for) medical data analyses, for both routine workflows and scientific research. +## About the 'certedata' universe -For all our packages, please visit [our GitHub organisation overview](https://github.com/certe-medical-epidemiology). Our R packages are not on CRAN since their use is primarily intended for own staff, but they are publicly available to support open science. - -#### R-universe - -All our R packages are published [here at R-universe](https://certe-medical-epidemiology.r-universe.dev), allowing anyone to install and update the packages using common methods, such as the RStudio menu bar or `install.packages()`. To use the R-universe of Certe Medical Epidemiology, run: - -```r -# set the repos option to include the Certe Medical Epidemiology R-universe -options(repos = c( - CerteMedEpi = "https://certe-medical-epidemiology.r-universe.dev", - CRAN = "https://cloud.r-project.org")) - -# our 'loader package' certedata installs all Certe R packages: -install.packages("certedata") -``` - -
+
The certedata R package The certestyle R package - - The certetoolbox R package - - - The certemail R package + + The certeapi R package - - The certeprojects R package + + + The certeplot2 R package The certedb R package - - The certeplot2 R package + + The certeprojects R package + + + + The certemail R package + + + The certestats R package + + + The certegis R package + + + The certetoolbox R package
-### Copyright regarding this software +These are R packages developed by [**Certe**](https://www.certe.nl), a non-profit organisation for integrated medical diagnostics and advice for primary and secondary healthcare. Certe provides high-quality medical diagnostics and related products and services for healthcare providers and their patients. Hospitals, (general) practitioners, midwives and thus hundreds of thousands of people have relied on Certe's care for many years. + +Their department of Medical Epidemiology, which developed these R packages, conducts (and develops new methods for) medical data analyses, for both routine workflows and scientific research. For all our packages, please visit [our GitHub organisation overview](https://github.com/certe-medical-epidemiology). Our R packages are not on CRAN since their use is primarily intended for own staff, but they are publicly available to support open science. + +### Install + +All our R packages are published [here at R-universe](https://certe-medical-epidemiology.r-universe.dev), allowing anyone to install and update the packages using common methods, such as the RStudio menu bar or `install.packages()`. To add the Certe Medical Epidemiology R-universe to your existing repositories, run: + +```r +options(repos = c( + CerteMedEpi = "https://certe-medical-epidemiology.r-universe.dev", + options()$repos) +``` + +You can now install any Certe R package, e.g.: + +```r +# our 'loader package' certedata installs all Certe R packages this way: +install.packages("certedata", dependencies = TRUE) + +# or install a specific package: +install.packages("certegis") +install.packages("certeplot2") +install.packages("certestats") +``` + +### Developer status + +| Certe R Package | Latest release | R unit tests | Code coverage | Code compliance | Changelog | +|:----------------|:--------------:|:------------:|:-------------:|:---------------:|:---------:| +| [`certeapi`](https://certe-medical-epidemiology.github.io/certeapi) | [![R-universe](https://certe-medical-epidemiology.r-universe.dev/badges/certeapi?color=22bb55)](https://certe-medical-epidemiology.r-universe.dev) | [![R-CMD-check](https://github.com/certe-medical-epidemiology/certeapi/actions/workflows/R-CMD-check.yaml/badge.svg?branch=main)](https://github.com/certe-medical-epidemiology/certeapi/actions/workflows/R-CMD-check.yaml) | [![codecov](https://codecov.io/gh/certe-medical-epidemiology/certeapi/branch/main/graph/badge.svg)](https://codecov.io/gh/certe-medical-epidemiology/certeapi) | [![CodeFactor](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certeapi/badge/main)](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certeapi/) | [![commits](https://badgen.net/github/commits/certe-medical-epidemiology/certeapi/main?icon=github&color=green)](https://github.com/certe-medical-epidemiology/certeapi/commits/main) | +| [`certedata`](https://certe-medical-epidemiology.github.io/certedata) | [![R-universe](https://certe-medical-epidemiology.r-universe.dev/badges/certedata?color=22bb55)](https://certe-medical-epidemiology.r-universe.dev) | [![R-CMD-check](https://github.com/certe-medical-epidemiology/certedata/actions/workflows/R-CMD-check.yaml/badge.svg?branch=main)](https://github.com/certe-medical-epidemiology/certedata/actions/workflows/R-CMD-check.yaml) | [![codecov](https://codecov.io/gh/certe-medical-epidemiology/certedata/branch/main/graph/badge.svg)](https://codecov.io/gh/certe-medical-epidemiology/certedata) | [![CodeFactor](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certedata/badge/main)](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certedata/) | [![commits](https://badgen.net/github/commits/certe-medical-epidemiology/certedata/main?icon=github&color=green)](https://github.com/certe-medical-epidemiology/certedata/commits/main) | +| [`certedb`](https://certe-medical-epidemiology.github.io/certedb) | [![R-universe](https://certe-medical-epidemiology.r-universe.dev/badges/certedb?color=22bb55)](https://certe-medical-epidemiology.r-universe.dev) | [![R-CMD-check](https://github.com/certe-medical-epidemiology/certedb/actions/workflows/R-CMD-check.yaml/badge.svg?branch=main)](https://github.com/certe-medical-epidemiology/certedb/actions/workflows/R-CMD-check.yaml) | [![codecov](https://codecov.io/gh/certe-medical-epidemiology/certedb/branch/main/graph/badge.svg)](https://codecov.io/gh/certe-medical-epidemiology/certedb) | [![CodeFactor](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certedb/badge/main)](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certedb/) | [![commits](https://badgen.net/github/commits/certe-medical-epidemiology/certedb/main?icon=github&color=green)](https://github.com/certe-medical-epidemiology/certedb/commits/main) | +| [`certegis`](https://certe-medical-epidemiology.github.io/certegis) | [![R-universe](https://certe-medical-epidemiology.r-universe.dev/badges/certegis?color=22bb55)](https://certe-medical-epidemiology.r-universe.dev) | [![R-CMD-check](https://github.com/certe-medical-epidemiology/certegis/actions/workflows/R-CMD-check.yaml/badge.svg?branch=main)](https://github.com/certe-medical-epidemiology/certegis/actions/workflows/R-CMD-check.yaml) | [![codecov](https://codecov.io/gh/certe-medical-epidemiology/certegis/branch/main/graph/badge.svg)](https://codecov.io/gh/certe-medical-epidemiology/certegis) | [![CodeFactor](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certegis/badge/main)](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certegis/) | [![commits](https://badgen.net/github/commits/certe-medical-epidemiology/certegis/main?icon=github&color=green)](https://github.com/certe-medical-epidemiology/certegis/commits/main) | +| [`certemail`](https://certe-medical-epidemiology.github.io/certemail) | [![R-universe](https://certe-medical-epidemiology.r-universe.dev/badges/certemail?color=22bb55)](https://certe-medical-epidemiology.r-universe.dev) | [![R-CMD-check](https://github.com/certe-medical-epidemiology/certemail/actions/workflows/R-CMD-check.yaml/badge.svg?branch=main)](https://github.com/certe-medical-epidemiology/certemail/actions/workflows/R-CMD-check.yaml) | [![codecov](https://codecov.io/gh/certe-medical-epidemiology/certemail/branch/main/graph/badge.svg)](https://codecov.io/gh/certe-medical-epidemiology/certemail) | [![CodeFactor](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certemail/badge/main)](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certemail/) | [![commits](https://badgen.net/github/commits/certe-medical-epidemiology/certemail/main?icon=github&color=green)](https://github.com/certe-medical-epidemiology/certemail/commits/main) | +| [`certeplot2`](https://certe-medical-epidemiology.github.io/certeplot2) | [![R-universe](https://certe-medical-epidemiology.r-universe.dev/badges/certeplot2?color=22bb55)](https://certe-medical-epidemiology.r-universe.dev) | [![R-CMD-check](https://github.com/certe-medical-epidemiology/certeplot2/actions/workflows/R-CMD-check.yaml/badge.svg?branch=main)](https://github.com/certe-medical-epidemiology/certeplot2/actions/workflows/R-CMD-check.yaml) | [![codecov](https://codecov.io/gh/certe-medical-epidemiology/certeplot2/branch/main/graph/badge.svg)](https://codecov.io/gh/certe-medical-epidemiology/certeplot2) | [![CodeFactor](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certeplot2/badge/main)](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certeplot2/) | [![commits](https://badgen.net/github/commits/certe-medical-epidemiology/certeplot2/main?icon=github&color=green)](https://github.com/certe-medical-epidemiology/certeplot2/commits/main) | +| [`certeprojects`](https://certe-medical-epidemiology.github.io/certeprojects) | [![R-universe](https://certe-medical-epidemiology.r-universe.dev/badges/certeprojects?color=22bb55)](https://certe-medical-epidemiology.r-universe.dev) | [![R-CMD-check](https://github.com/certe-medical-epidemiology/certeprojects/actions/workflows/R-CMD-check.yaml/badge.svg?branch=main)](https://github.com/certe-medical-epidemiology/certeprojects/actions/workflows/R-CMD-check.yaml) | [![codecov](https://codecov.io/gh/certe-medical-epidemiology/certeprojects/branch/main/graph/badge.svg)](https://codecov.io/gh/certe-medical-epidemiology/certeprojects) | [![CodeFactor](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certeprojects/badge/main)](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certeprojects/) | [![commits](https://badgen.net/github/commits/certe-medical-epidemiology/certeprojects/main?icon=github&color=green)](https://github.com/certe-medical-epidemiology/certeprojects/commits/main) | +| [`certestats`](https://certe-medical-epidemiology.github.io/certestats) | [![R-universe](https://certe-medical-epidemiology.r-universe.dev/badges/certestats?color=22bb55)](https://certe-medical-epidemiology.r-universe.dev) | [![R-CMD-check](https://github.com/certe-medical-epidemiology/certestats/actions/workflows/R-CMD-check.yaml/badge.svg?branch=main)](https://github.com/certe-medical-epidemiology/certestats/actions/workflows/R-CMD-check.yaml) | [![codecov](https://codecov.io/gh/certe-medical-epidemiology/certestats/branch/main/graph/badge.svg)](https://codecov.io/gh/certe-medical-epidemiology/certestats) | [![CodeFactor](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certestats/badge/main)](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certestats/) | [![commits](https://badgen.net/github/commits/certe-medical-epidemiology/certestats/main?icon=github&color=green)](https://github.com/certe-medical-epidemiology/certestats/commits/main) | +| [`certestyle`](https://certe-medical-epidemiology.github.io/certestyle) | [![R-universe](https://certe-medical-epidemiology.r-universe.dev/badges/certestyle?color=22bb55)](https://certe-medical-epidemiology.r-universe.dev) | [![R-CMD-check](https://github.com/certe-medical-epidemiology/certestyle/actions/workflows/R-CMD-check.yaml/badge.svg?branch=main)](https://github.com/certe-medical-epidemiology/certestyle/actions/workflows/R-CMD-check.yaml) | [![codecov](https://codecov.io/gh/certe-medical-epidemiology/certestyle/branch/main/graph/badge.svg)](https://codecov.io/gh/certe-medical-epidemiology/certestyle) | [![CodeFactor](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certestyle/badge/main)](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certestyle/) | [![commits](https://badgen.net/github/commits/certe-medical-epidemiology/certestyle/main?icon=github&color=green)](https://github.com/certe-medical-epidemiology/certestyle/commits/main) | +| [`certetoolbox`](https://certe-medical-epidemiology.github.io/certetoolbox) | [![R-universe](https://certe-medical-epidemiology.r-universe.dev/badges/certetoolbox?color=22bb55)](https://certe-medical-epidemiology.r-universe.dev) | [![R-CMD-check](https://github.com/certe-medical-epidemiology/certetoolbox/actions/workflows/R-CMD-check.yaml/badge.svg?branch=main)](https://github.com/certe-medical-epidemiology/certetoolbox/actions/workflows/R-CMD-check.yaml) | [![codecov](https://codecov.io/gh/certe-medical-epidemiology/certetoolbox/branch/main/graph/badge.svg)](https://codecov.io/gh/certe-medical-epidemiology/certetoolbox) | [![CodeFactor](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certetoolbox/badge/main)](https://www.codefactor.io/repository/github/certe-medical-epidemiology/certetoolbox/) | [![commits](https://badgen.net/github/commits/certe-medical-epidemiology/certetoolbox/main?icon=github&color=green)](https://github.com/certe-medical-epidemiology/certetoolbox/commits/main) | + +### Copyright -We believe open science matters, which is why this package is available on GitHub. +We believe open science matters, which is why these R packages are publicly available on GitHub. -This R package is free, open-source software and licensed under the [GNU General Public License v2.0 (GPL-2)](./LICENSE.md). In a nutshell, this means that this package: +They are free, open-source software and are all licensed under the [GNU General Public License v2.0 (GPL-2)](./LICENSE.md). In a nutshell, this means that our R packages: - May be used for commercial purposes - May be used for private purposes @@ -66,8 +98,8 @@ This R package is free, open-source software and licensed under the [GNU General - May be distributed, although: - Source code **must** be made available when the package is distributed - A copy of the license and copyright notice **must** be included with the package. -- Comes with a LIMITATION of liability -- Comes with NO warranty +- Come with a LIMITATION of liability +- Come with NO warranty ----