valtools helps automate the validation of R packages used in clinical research and drug development: It provides useful templates and helper functions for tasks that arise during project set up and development of the validation framework.

This package is created by the R Package Validation Framework PHUSE Working Group.

For background on the R Package Validation Framework, watch this presentation from RStudio::Global Pharma X Session.

Installation

{valtools} is under active development. To get the latest version, install from github:

devtools::install_github("phuse-org/valtools")

Usage

{valtools} is intended to be a bolt-on addition to the standard package development process followed by usethis and devtools. All {valtools} functions start with vt followed by a verb/descriptor to make them easy to follow. The most common usage for valtools is to add elements required for validation under the R Package Validation Framework and facilitating validation. See the Starting New Validation Package using {valtools} vignette for more details.

Adding Validation Content

Authoring A Validation Report

These functions are helper functions for use within the validation report Rmd.

Validating

  • vt_validate_source() installs the package temporarily and executes the validation report rmd to validate the source code on the current system.
  • vt_validate_build() installs the package temporarily, executes the validation report rmd, and compiles it into a bundle for installing.
  • vt_validate_install() installs the package temporarily, executes the validation report rmd, and installs the library to the machine.
  • vt_validate_installed_package() runs the validation report rmd for a package that was installed using vt_validate_install() for when the environment has changed.

Vignettes

Read the Starting New Validation Package using {valtools} vignette for a high level overview of the functions that exist in {valtools} and their intended uses.

Cheat Sheet

Cheat sheet on how to use the {valtools} R Package

Cheatsheet on how to use the {valtools} R Package - functions

Cheatsheet on how to use the {valtools} R Package - functions & validation modes

Code of conduct

Please note that the {valtools} project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.