search

codecheckers / codecheck

R package assistant for conducting a CODECHECK
MIT License
10 stars 3 forks source link

Template for codecheck.Rmd #58

Open langtonhugh opened 2 months ago

langtonhugh commented 2 months ago

The QMD file codecheck.Rmd that is generated after executing codecheck::create_codecheck_files() is for an existing report, rather than a demo template, and therefore does not knit without codecheckers first updating the manifest files with their own material. It would be useful for (first time) codecheckers to have a template that knits without any changes, using placeholder manifest files, so that they can better understand how to make their own report. Happy to make these changes if it's useful.

nuest commented 2 months ago

Yes, this would be very welcome.

I have to admit that I myself mostly work with an Rmd document that does not include the manifest at all, because most of my checks use the Reproducible AGILE template (https://github.com/reproducible-agile/reviews-2024/blob/main/report-template/reproreview-template.Rmd).

@langtonhugh Did you find the code utilising the manifest understandable and useful?

I'm happy to review this change and even happier if @sje30 can share his thoughts.

langtonhugh commented 1 month ago

I did not understand the use of manifest files at first. If the manifest files in the template are placeholder files that are downloaded when users execute remotes::install_github("codecheckers/codecheck"), then the initial build will work, and new users can better understand their role. Manifest files could also be defined in the README #59