FredHutch / VISCtemplates

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

Reorganize/rename code files nested under R/ #135

Closed kelliemac closed 6 days ago

kelliemac commented 3 months ago

I find the files R/template.R and R/report_template.R to have confusing and uninformative names, with a lack of clarity about what is in each file and maybe too many functions in each one. I propose the following:

  1. Rename report_template.R to report_functions.R
  2. Split template.R into use_visc_report.R (containing most of the contents) and visc_pdf_document.R (containing only the visc_pdf_document function) and visc_word_document.R (containing only the visc_word_document function)
kelliemac commented 3 months ago

@mayerbry it would be good to get your feedback on this! I think better organization would help other folks contribute to the repo more easily. But I don't want to make any changes unless others agree it seems helpful (or at the very least, not unhelpful).