/
README.Rmd
45 lines (30 loc) · 2.13 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
---
output: github_document
---
```{r knitr setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE, comment = "#>")
```
# `exampletestr` <img src="man/figures/logo.png" align="right" height=140/>
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)
![RStudio CRAN monthly downloads](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.