{"repo":"insightsengineering/thevalidatoR","free":true,"listed":false,"github":"https://github.com/insightsengineering/thevalidatoR","clone":"git clone https://github.com/insightsengineering/thevalidatoR.git","description":"Github Action that generates R Package Validation documentation 🏁","language":"R","stars":64,"topics":["github-actions","r","validation","r-package-automation"],"license":"MIT","category":"workflow-automation","readme_excerpt":"thevalidatoR - thevalidatoR - An R Package Validation Report - Description - Action Type - Author - Inputs - Outputs - How to use - Quickstart - V1.0 Examples - rbmi - admiral R Package Validation Report Description A Github Action that generates a validation report for an R package. The four main steps are: - Run R CMD check (check installation) - Run covr::package coverage() (check unit test coverage) - Run covtracer (link documentation to unit tests) - Place results into report - Attach report as object to release Action Type Composite Author Roche Inputs report pkg dir : Description : Path to package's root. Required : false Default : . report template path : Description : File path of the R markdown template to use for the report. The default template is available here. Required : false Default : ./template.qmd no cache : Description : Disable github action R dependency caching Required : false Default : false cache version : Description : Version of the cache. To clean cache bump this version. Required : false Default : v1 disable install dev deps : Description : Disable installation of dev dependencies while building the report. Required : false Default : false Outputs None How to use To use this GitHub Action you will need to complete the following: - Create a new file in your repository called .github/workflows/r-pkg-validation.yml - Copy the template over (and edit if you wish to modify it) Quickstart In your repository you should have a .github/workflows/validatoR.","default_branch":null,"files":null,"tree":[],"storefront":"/r/insightsengineering","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/insightsengineering/thevalidatoR/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}