adoptr Validation Report

This repository contains code to build an automated validation report for the 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. 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?
License	MIT, https://github.com/kkmann/adoptr/blob/master/LICENSE.md
CRAN?
Long-term storage?
# Downloads	R Studio CRAN mirror:
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

git clone https://github.com/kkmann/adoptr-validation-report.git

and switch to the newly created folder

cd adoptr-validation-report

Install the dependencies listed in the DESCRIPTION file, i.e.

install.packages(c("adoptr", "tidyverse", "bookdown", "rpact", "testthat", "pwr", "tinytex"))

before finally building the book via

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.