https://github.com/mllg/checkmate

Fast and versatile argument checks
https://github.com/mllg/checkmate

assertions cran r testthat

Last synced: 3 days ago
JSON representation

Fast and versatile argument checks

• Host: GitHub
• URL: https://github.com/mllg/checkmate
• Owner: mllg
• License: other
• Created: 2013-12-27T23:42:35.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2024-08-10T09:54:32.000Z (5 months ago)
• Last Synced: 2025-01-02T10:03:36.443Z (10 days ago)
• Topics: assertions, cran, r, testthat
• Language: R
• Homepage: https://mllg.github.io/checkmate/
• Size: 16.7 MB
• Stars: 266
• Watchers: 7
• Forks: 30
• Open Issues: 67
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - mllg/checkmate - Fast and versatile argument checks (R)

README

        
# checkmate

[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/checkmate)](https://cran.r-project.org/package=checkmate)

[![R build status](https://github.com/mllg/checkmate/workflows/R-CMD-check/badge.svg)](https://github.com/mllg/checkmate)

[![Coverage Status](https://img.shields.io/coveralls/mllg/checkmate.svg)](https://coveralls.io/github/mllg/checkmate)

[![Download Stats](https://cranlogs.r-pkg.org/badges/checkmate)](https://cran.r-project.org/package=checkmate)

Fast and versatile argument checks for R.

Ever used an R function that produced a not-very-helpful error message,

just to discover after minutes of debugging that you simply passed a wrong argument?

Blaming the laziness of the package author for not doing such standard checks

(in a dynamically typed language such as R) is at least partially unfair, as R makes theses types of checks

cumbersome and annoying. Well, that's how it was in the past.

Enter checkmate.

Virtually **every standard type of user error** when passing arguments into function can be

caught with a simple, readable line which produces an **informative error message** in case.

A substantial part of the package was written in C to **minimize any worries about execution time overhead**.

Furthermore, the package provides over 30 expectations to extend the popular [testthat package](https://cran.r-project.org/package=testthat) for unit tests.

## Installation

For the stable release, just install the latest version from [CRAN](https://cran.r-project.org/package=checkmate):

```{R}

install.packages("checkmate")

```

For the development version, use [devtools](https://cran.r-project.org/package=devtools):

```{R}

devtools::install_github("mllg/checkmate")

```

## Resources

* [R Journal Paper](https://journal.r-project.org/archive/2017/RJ-2017-028/index.html)

* [NEWS](https://github.com/mllg/checkmate/blob/master/NEWS.md)

* [Documentation/Vignettes](https://mllg.github.io/checkmate/)

* [Grouped function reference](https://mllg.github.io/checkmate/reference/checkmate-package)