https://github.com/kkmann/adoptr-validation-report
R markdown-based validation report for the package adoptr.
https://github.com/kkmann/adoptr-validation-report
Last synced: 12 months ago
JSON representation
R markdown-based validation report for the package adoptr.
- Host: GitHub
- URL: https://github.com/kkmann/adoptr-validation-report
- Owner: kkmann
- License: other
- Created: 2019-03-30T15:50:11.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-12-28T02:34:46.000Z (over 4 years ago)
- Last Synced: 2025-08-04T12:37:05.140Z (12 months ago)
- Language: R
- Homepage: https://kkmann.github.io/adoptr-validation-report/
- Size: 14.6 MB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/kkmann/adoptr-validation-report/actions/workflows/build-and-deplay-validation-report.yml)
# **adoptr** Validation Report
This repository contains code to build an automated validation report for the
[**adoptr**](https://github.com/kkmann/adoptr) R package.
The report is build using R Markdown and the **bookdown**
(https://github.com/rstudio/bookdown) package.
The most recent build of the validation report is hosted on this repository's
GitHub pages site, [here](https://kkmann.github.io/adoptr-validation-report/).
The report itself contains a brief description of the neccessary steps to
produce a report for a local installation of **adoptr**.
The following quality metrics are inspired by https://www.pharmar.org/packages/:
| **Metric** | **Value/Statement** |
|:------------------------------------|:--------------------|
| **Vignette?** | https://kkmann.github.io/adoptr/articles/adoptr.html |
| **Website?** | https://kkmann.github.io/adoptr |
| **Version Control?** | https://github.com/kkmann |
| **Public/Open Source Development?** | https://github.com/kkmann |
| **Formal Bug Tracking?** | https://github.com/kkmann/adoptr/issues |
| **Changelog?** | https://kkmann.github.io/adoptr/news/index.html |
| **Release Cycle** | irregular |
| **Unit Testing?** | [](https://codecov.io/gh/kkmann/adoptr) |
| **License** | MIT, https://github.com/kkmann/adoptr/blob/master/LICENSE.md |
| **CRAN?** | [](https://cran.r-project.org/package=adoptr) |
| **Long-term storage?** | [](https://doi.org/10.5281/zenodo.2616951) |
| **# Downloads** | R Studio CRAN mirror: [](https://cran.r-project.org/package=adoptr) [](https://cran.r-project.org/package=adoptr) |
| **Maturity** | Initial CRAN release date: 2019-04-01 |
## Creating a Local Validation Report
To validate a local version of **adoptr**, clone the validation report
source repository via
```bash
git clone https://github.com/kkmann/adoptr-validation-report.git
```
and switch to the newly created folder
```bash
cd adoptr-validation-report
```
Install the dependencies listed in the DESCRIPTION file, i.e.
```R
install.packages(c("adoptr", "tidyverse", "bookdown", "rpact", "testthat", "pwr", "tinytex"))
```
before finally building the book via
```bash
Rscript -e 'bookdown::render_book("index.Rmd", output_format = "all")'
```
(or executing the equivalent command in an R terminal in the same folder).
This will produce a `_book` folder with an `index.html` file that can be
viewed in a browser as well as the PDF version of the validation
report.