https://github.com/rorynolan/exampletestr

An R package for help with writing unit tests based on examples in documentation. Slightly similar to python's doctests.
https://github.com/rorynolan/exampletestr

Last synced: about 2 months ago
JSON representation

An R package for help with writing unit tests based on examples in documentation. Slightly similar to python's doctests.

• Host: GitHub
• URL: https://github.com/rorynolan/exampletestr
• Owner: rorynolan
• License: gpl-3.0
• Created: 2017-02-16T17:14:12.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-06-11T00:26:30.000Z (over 1 year ago)
• Last Synced: 2024-04-25T16:41:48.042Z (9 months ago)
• Language: R
• Homepage: https://rorynolan.github.io/exampletestr
• Size: 10.4 MB
• Stars: 38
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - rorynolan/exampletestr - An R package for help with writing unit tests based on examples in documentation. Slightly similar to python's doctests. (R)

README

        
---

output: github_document

---

```{r knitr setup, include=FALSE}

knitr::opts_chunk$set(echo = TRUE, comment = "#>")

```

# `exampletestr` 

An R package to help developers create unit tests (designed for use with the `testthat` package) for their package, based on the examples in their package documentation.

[![R-CMD-check](https://github.com/rorynolan/exampletestr/workflows/R-CMD-check/badge.svg)](https://github.com/rorynolan/exampletestr/actions)

![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)

[![lifecycle](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)

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

[![RStudio CRAN downloads](http://cranlogs.r-pkg.org/badges/grand-total/exampletestr)](http://cranlogs.r-pkg.org/badges/grand-total/exampletestr)

[![RStudio CRAN monthly downloads](http://cranlogs.r-pkg.org/badges/exampletestr)](http://cranlogs.r-pkg.org/badges/exampletestr)

## Installation

To install the release version from [CRAN](https://cran.r-project.org/package=exampletestr):

```{r Install-exampletestr, eval=FALSE}

install.packages("exampletestr")

```

To install the dev version from [GitHub](https://github.com/rorynolan/exampletestr):

```{r Install-dev-exampletestr, eval=FALSE}

remotes::install_github("rorynolan/exampletestr")

```

## Use

To learn how to use `exampletestr`, visit the package's website at https://rorynolan.github.io/exampletestr/.

## Contributing

The preferred method of contribution is via GitHub pull request. Please note that the `exampletestr` project is released with a [Contributor Code of Conduct](inst/CODE_OF_CONDUCT.md).

By contributing to this project, you agree to abide by its terms.

# Contribution

Contributions to this package are welcome. The preferred method of contribution is through a github pull request. Feel free to contact me by creating an issue. Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.