FredHutch / VISCtemplates

Tools for writing reproducible reports at VISC
Other
6 stars 2 forks source link

document with general report tips #119

Open mayerbry opened 1 year ago

mayerbry commented 1 year ago

There are repeated task that often come with PT report writing (ex., linting, running spelling check, locking a pdf with reply comments, specific git commands) that are easy to forget.

I think we should make a report-tips (or whatever name) markdown that is saved into the docs with project creation. This would serve as a reference for these things and can be updated as needed

kelliemac commented 10 months ago

If we want to automate tasks like linting and spell checking (which I think would be a good idea!) two ways to do this are: 1) with a create_report.R file like the HVTN reports use (people run this file instead of clicking the knit button in Rstudio), or 2) with GitHub actions that automatically run certain code/tests when, for example, a push or PR is made.

kelliemac commented 7 months ago

For the hackathon, it would be great if a team could brainstorm ideas for this and draft something simple that we can then iterate on. For example, maybe just focus on linting or spell check.

kelliemac commented 1 month ago

a couple of notes from a conversation with @mayerbry a while back: VISCfunctions::stat_paste() is really helpful, as are nest and unnest and purr