search

reproducible-reporting / stepup-reprep

StepUp RepRep is the StepUp extension for Reproducible Reporting
https://reproducible-reporting.github.io/stepup-reprep/
GNU General Public License v3.0
3 stars 3 forks source link

Rewrite "Template Conventions" as a set of recommendations with motivation and context #6

Open tovrstra opened 3 months ago

tovrstra commented 3 months ago

As noted in #1, the Template Conventions "tutorial" is not really a tutorial, but rather a set of rules without much background.

It should be rewritten as a set of recommendations, with references to more detailed descriptions of the motivation and context that led to each rule. This will help the reader decide which recommendations are worth following and which are not.

tovrstra commented 3 months ago

One of the points requiring elaboration is the use of Jupyter Notebooks. We should discuss strengths and weaknesses in the context of reproducibility.

tovrstra commented 3 months ago

This is partially addressed on the brand-new data management template: https://github.com/reproducible-reporting/dmp-template