Comment on page

Benefits of 'dynamic docs'

By “Dynamic Documents” I mean papers/projects built with R-markdown or JuPyTer notebooks (the two most prominent tools) that
  • do and report the data analysis (as well as math/simulations) in the same space that the results and discussion are presented (with ‘code blocks’ hidden)
  • a key benefit is you can track exactly what is being reported and how it was constructed;
    • this makes it a lot less error-prone
    • and helps readers understand it better (see 'explorable explanations')
    • and helps replicators and future researchers build on it
  • other advantages of these formats (over, e.g., pdf) include convenient ‘folding blocks’, margin comments or hoverable notes and links, and integrating interactive tools

Better examples, the case for dynamic documents

Also consider...
  • Elife's 'editable graphics'... Brett Viktor?
  • see corrigendum in journals Reinhart and Rogoff error?
  • open science MOOC in R markdown ...
  • OSF and all of their training/promo materials in OS

Reinstein's own examples

Some quick examples from my own work in progress (but other people have done it much better)

Other (randomly selected) examples