search

FredHutch / VISCtemplates

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

Update report README #92

Open monicagerber opened 2 years ago

monicagerber commented 2 years ago

Update report README template so that the versioning is tied to the VISCtemplates version number. README should be created with use_visc_report() instead of when document is knitted. When document is knitted, it checks for README if README=TRUE in yaml.

kelliemac commented 2 days ago

@asatofh I am going to tackle this issue soon and am wondering, do we still want to have README files nested under report folders, or is it better to have them under the assay folders? Personally I prefer having them at the assay folder level (e.g. RepoName/bcell/README.md) and having notes about all of the report versions included in the that same README. But the current VISCtemplates practices is to put READMEs within each individual report's folder (e.g. RepoName/bcell/ReportName/README.md).