Welcome to the R Package Validation Tutorial!
Based on the R Package Validation Framework White Paper that is in pubic review under PHUSE, this tutorial aims to teach the basics of the R Package Validation Framework and its application using {valtools}. The training will show how to use the {valtools} package to create a validation packet as well as how to apply this to R package development.
{valtools} can be found at: https://github.com/phuse-org/valtools
| 🗓️ R/Pharma Conf, Friday, November 5th, 2021 |
| 👨💻 @thebioengineer |
| 👩💻 @mariev |
Slides and exercises are grouped by section. Exercises are split into
Sparse or Verbose, indicating the amount of supplementary
information provided. An answer key is also provided in the folder.
| Time | Section | Slides | Exercises |
|---|---|---|---|
| 0 - 5 | Welcome and Orientation | Welcome Slides | |
| 5 - 25 | Concepts of R Package Validation | Introduction to the R Package Validation Framework | |
| 25 - 35 | Introduction to {valtools} | Intro to {valtools} | |
| 35 - 75 | Elements of Validation Part 1 | Elements of Validation Part 1 | 04: Writing Requirements |
| 75 - 85 | Break/Q&A | ||
| 85 - 125 | Elements of Validation Part 2 | Elements of Validation Part 2 | 05: Validation Reports |
| 125 - 155 | Managing Validation Projects | Managing Validation Projects | 06: Managing Validation Projects |
| 155 - 165 | Internal R Packages | R Packages | |
| 165 - 180 | Q&A / Panel Discussion |
- RStudio cloud instructions
- [Optional] setup for running code locally:
# you will need to install the following packages from CRAN
install.packages(c("devtools", "roxygen2", "testthat", "usethis", "knitr"))
# you will need to install the following packages from github
remotes::install_github("phuse-org/valtools", build_vignettes = TRUE)This tutorial addresses a major knowledge gap in the R ecosystem: getting R accepted into highly regulated industries. This is an opportunity for those that work in these industries to be empowered to expand the use of R. We are taking an approach where some basic R knowledge is expected, such as writing scripts and functions, but teaching people to take the next steps.
Previous work presented to the community has shown a framework for developers to distribute validation-ready R packages, which has been met with enthusiasm among R users in pharma. In this tutorial participants will experience the process of creating R packages with validation resources in place and explore how addition of these materials perform in a variety of real-world scenarios, including validation-on-install and validation-post-install. Participants will have the opportunity to practice how validation affects subsequent package releases.
This workshop was developed by employees of Fred Hutch Cancer Research Center - SCHARP - VISC. We also received support from R/Pharma in the form of RStudio Cloud access to facilitate training.
| Conference | Tag |
|---|---|
| Cascadia R Conf 2021 - July 4th, 2021 | CascadiaRConf2021 |
| PHUSE CSS 2021 - September 13th, 2021 | PhUSECSS2021 |