
<!-- README.md is generated from README.Rmd. Please edit that file -->

# rdcmchecks <a href="https://rdcmchecks.r-dcm.org"><img src="man/figures/logo.png" align="right" height="138" alt="rdcmchecks website" /></a>

<!-- badges: start -->

[![Project Status: Active – The project has reached a stable, usable
state and is being actively
developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![lifecycle](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)
[![R package
version](https://www.r-pkg.org/badges/version/rdcmchecks)](https://cran.r-project.org/package=rdcmchecks)
[![Package
downloads](https://cranlogs.r-pkg.org/badges/grand-total/rdcmchecks)](https://cran.r-project.org/package=rdcmchecks)</br>
[![R-CMD-check](https://github.com/r-dcm/rdcmchecks/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-dcm/rdcmchecks/actions/workflows/R-CMD-check.yaml)
[![Codecov test
coverage](https://codecov.io/gh/r-dcm/rdcmchecks/graph/badge.svg)](https://app.codecov.io/gh/r-dcm/rdcmchecks?branch=main)
[![GitHub
pages](https://github.com/r-dcm/rdcmchecks/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/r-dcm/rdcmchecks/actions/workflows/pkgdown.yaml)</br>
[![Signed
by](https://img.shields.io/badge/Keybase-Verified-brightgreen.svg)](https://keybase.io/wjakethompson)
![License](https://img.shields.io/badge/License-MIT-blue.svg)
<!-- badges: end -->

The goal of rdcmchecks is to provide utility functions for checking
arguments provided to functions across the suite of r-dcm packages.
Rather than duplicating code for checking arguments across packages,
check functions can be added to rdcmchecks, which can in turn be
imported to any needed packages.

## Installation

You can install the released version of rdcmchecks from
[CRAN](https://cran.r-project.org/) with:

``` r
install.packages("rdcmchecks")
```

And the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("pak")
pak::pak("r-dcm/rdcmchecks")
```

------------------------------------------------------------------------

## Contributions and Code of Conduct

Contributions are welcome. To ensure a smooth process, please review the
[Contributing Guide](https://dcmdata.r-dcm.org/CONTRIBUTING.html).
Please note that the rdcmchecks project is released with a [Contributor
Code of Conduct](https://rdcmchecks.r-dcm.org/CODE_OF_CONDUCT.html). By
contributing to this project, you agree to abide by its terms.
