search

HEGSRR / HEGSRR-Template

Template documents and packages for study pre-registration, reproductions, and replications
https://hegsrr.github.io/HEGSRR-Manual
BSD 3-Clause "New" or "Revised" License
14 stars 5 forks source link

generating reports #7

Closed josephholler closed 1 year ago

josephholler commented 3 years ago

We need to move toward having the pre-analysis plan, code, outputs, everything in the same R markdown file or Jupyter notebook. For Markdown, use knitr to generate the report https://yihui.org/knitr/ For Jupyter, use stitch https://pystitch.github.io/

When knitr or stitch is run, the report can be saved to the reports folder. At that time, the researcher should commit a Version of the Git repository, and then continue revising the main notebook / rmarkdown. This will reduce redundancies while recording provenance of the data, research plan, and code.

josephholler commented 1 year ago

copied recommendation to ideation chapter of manual, while another issue mentions need for template code