Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yonicd/covrpage
Create a summary readme for the testthat subdirectory to communicate with potential users
https://github.com/yonicd/covrpage
r
Last synced: about 1 month ago
JSON representation
Create a summary readme for the testthat subdirectory to communicate with potential users
- Host: GitHub
- URL: https://github.com/yonicd/covrpage
- Owner: yonicd
- License: other
- Created: 2018-04-27T00:49:38.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-18T22:58:56.000Z (almost 2 years ago)
- Last Synced: 2024-10-12T21:28:53.479Z (2 months ago)
- Topics: r
- Language: R
- Homepage: https://yonicd.github.io/covrpage/
- Size: 1.29 MB
- Stars: 52
- Watchers: 7
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - yonicd/covrpage - Create a summary readme for the testthat subdirectory to communicate with potential users (R)
README
---
output: github_document
always_allow_html: yes
---
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
fig.path = "man/figures/",
comment = "#>"
)
```
[](https://travis-ci.org/yonicd/covrpage)
[](https://codecov.io/github/yonicd/covrpage?branch=master)
[](http://tinyurl.com/yayrd3et)
# covrpage `r if(knitr::opts_knit$get('rmarkdown.pandoc.to')=='gfm-ascii_identifiers') '
'`
Trust is earned not ~~inherited~~ importedFrom. Now that you've built a cool package, you want potential users to trust it so that they might adopt it. How to build trust in your piece of software? Unit testing is part of the components building trustworthiness of your package. Imagine you're at the point where you've tested most lines of your code with thorough assertions, including checks of edge cases. Proof of that hard work will be a high test coverage, that potential users of your package might notice thanks to a bright green coverage badge. But how would they know your tests are thorough? That's what `covrpage` helps you with, by creating a [summary report](tests/README.md) of your tests that goes beyond the coverage percentage. This way, potential users can see at a glance how good the unit testing of your package is.
## Is `covrpage` report only for users?
No, it can also inform your work on your package, by helping you track progress of the unit tests you're working on, and it can show to potential _contributors_ where help is needed.
## Package Installation
```
# install.packages('remotes')
remotes::install_github('yonicd/covrpage')
```
## Usage
```
# assuming you are in your package root directory
covrpage::covrpage()
# create the covrpage and send directly to remote repository
covrpage::covrpage(auto_push = TRUE)
# Copy output as a vignette to use in pkgdown
covrpage::covrpage(vignette = TRUE)
# assuming you are not in your package directory
covrpage::covrpage(path = 'another_directory')
```
## Vignette
covrpage can be outputed as a vignette called `Tests and Coverage` making it part of the package help documentation and can be viewed as an [article](https://yonicd.github.io/covrpage/articles/tests_and_coverage.html) in a [pkgdown](https://github.com/r-lib/pkgdown) site.
## Articles
- [Getting Started](https://yonicd.github.io/covrpage/articles/get-started.html)
- [How to read the report](https://yonicd.github.io/covrpage/articles/how-to-read-covrpage-report.html)
- [Test Results](https://yonicd.github.io/covrpage/articles/Test_Results.html)
- [Continuous Integration](https://yonicd.github.io/covrpage/articles/Continuous_Integration.html)
## Repositories using covrpage
- [slackr](https://github.com/hrbrmstr/slackr/tree/master/tests)
- [remedy](https://github.com/thinkr-open/remedy/tree/master/tests)
- [mathpix](https://github.com/jonocarroll/mathpix/tree/master/tests)
- [carbonate](https://github.com/yonicd/carbonate/tree/master/tests)
- [GSEAdv](https://github.com/llrs/GSEAdv/tree/master/tests)
- [rfm](https://github.com/rsquaredacademy/rfm/tree/master/tests)
- [ggstatsplot](https://github.com/IndrajeetPatil/ggstatsplot/tree/master/tests)
- [Full List...](https://github.com/search?l=Markdown&o=desc&q=covrpage+filename%3AREADME.md+path%3Atests&s=indexed&type=Code)
If you also have `covrpage` on your site and want to add it to the list you can submit a [Pull Request](https://github.com/yonicd/covrpage/pulls?utf8=%E2%9C%93&q=is%3Apr) to this README.
## Contributing
[Locke Data](https://itsalocke.com) contributed code and creative input into this package as part of their ongoing [support offer](https://itsalocke.com/blog/package-support-offer/) designed to help boost the R ecosystem and support open source contributors. All rights associated with the work are granted to the copyright holder of this package.
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.
Any questions/comments are always welcome in the [issues](https://github.com/yonicd/covrpage/issues) section.