insightsengineering / thevalidatoR

Github Action that generates R Package Validation documentation 🏁
https://github.com/marketplace/actions/r-package-validation-report
MIT License
57 stars 5 forks source link

GSK feedback - important vs 'appendix' type information to improve readibility #51

Open epijim opened 2 years ago

epijim commented 2 years ago

Currently the report is very verbose, and not human friendly. Feedback received (in this meeting) to try and split it out - e.g. can we target something like 1 page that flags key issues, and push back things like the record of how each documented feature was tested to an appendix.

Tagging people that attended: @dgkf @epijim @tlblnk

An example report run on admiral with current template is attached.

validation-report.pdf