diff --git a/docs/package-review-checklist.md b/docs/package-review-checklist.md index d73d394..c415ebf 100644 --- a/docs/package-review-checklist.md +++ b/docs/package-review-checklist.md @@ -150,7 +150,7 @@ strongly recommended. ## Unit tests -- [ ] Unit tests present and covering large part of core functionality. +- [ ] Unit tests present and covering large part of core functionality. (recommend testing with `covr::package_coverage()`) ## R code diff --git a/unit-tests.Rmd b/unit-tests.Rmd index 4e8c404..122836c 100644 --- a/unit-tests.Rmd +++ b/unit-tests.Rmd @@ -123,7 +123,7 @@ complete set of tests. RUnit, tinytest, and testthat are robust testing solutions that are great tools for package development, which you choose to use for your package largely comes down to personal preference. However here is a brief list of strengths and -weaknesses of each. +weaknesses of each. Bioconductor slighlty prefers testthat ### RUnit Strengths ### @@ -343,11 +343,15 @@ refers to the percentage of your package code that is tested by your unit tests. Packages with higher coverage have a lower chance of containing bugs. +We highly recommend using the [covr package](https://cran.r-project.org/web/packages/covr/index.html) function +`package_coverage()` for evaluation. + If tests are taking too long to achieve full test coverage, see [long tests][]. Before implementing long tests we highly recommend reaching out to the bioconductor team on the [bioc-devel][bioc-devel-mail] mailing list to ensure proper use and justification. + ## Additional Resources Some web resources worth reading: