https://github.com/thebioengineer/validation

Repository for Validation of R Packages
https://github.com/thebioengineer/validation

Last synced: about 1 month ago
JSON representation

Repository for Validation of R Packages

• Host: GitHub
• URL: https://github.com/thebioengineer/validation
• Owner: thebioengineer
• Created: 2019-12-31T21:50:43.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-04-06T22:55:14.000Z (about 5 years ago)
• Last Synced: 2025-01-16T00:53:20.438Z (3 months ago)
• Language: HTML
• Homepage: https://thebioengineer.github.io/validation
• Size: 74.4 MB
• Stars: 9
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - thebioengineer/validation - Repository for Validation of R Packages (HTML)

README

        

#  RStudio::conf(2020): Approaches to Assay Processing Package Validation

Author: Ellis Hughes

twitter: @ellis_hughes

This is the respository for the 2020 RStudio::conf presentation `Approaches to Assay Processing Package Validation`.

📰: [Slides](https://thebioengineer.github.io/validation)

📦: [Sample Package](https://www.github.com/thebioengineer/validation/tree/master/sample_package/ValidateMe)

🎥: [Recording](https://resources.rstudio.com/rstudio-conf-2020/approaches-to-assay-processing-package-validation-ellis-hughes)

The focus of this presentation is to present an approach to simplify the process of validation of R packages. 

My motivation and development of this approach comes from developing an internal package that needed validation.

The current process required at least three word documents that needed to be updated, approved, and version at every step.

If anything changed, most everything had to be rewritten. 

In addition, by separating the validation process from the package development, duplication of effort was rampant. 

In an effort to reduce overhead and increase speed of development, I distilled the elements required of validation and reproduced it as part of the package development process.

Using packages that are already instrumental in modern package development, users can create all the documention necessary for a validation:

- Rmarkdown is used to write out the specifications, test cases, and generate the final validation document.

- Roxygen2 is used to track authorship and ownership of specifications, functions, test cases, and test case code.

- testthat is used to exectute the test case code and record results

I would like to thank my team at Fred Hutch for helping develop this idea and the code to generate the validation.

  - Marie Vendettuoli

  - Anthony Williams

  - Jimmy Fulp 

  - Bharathi Lakshminarayanan

  - Rafael Kuttner

  - Alicia Sato

  - Shannon Grant

  - Paul Stutzman

  - Kate Ostbye