2016-11-16

Why?

  • You have to understand what you have done
  • Others should be able to reproduce what you have done

'Lab notes' - useful practises

  • Put in results directory
  • Entries dated
  • Entries relatively verbose
  • Link to data and code (including versions)
  • Embedded images or tables showing results of analysis done
  • Observations, Conclusions, and ideas for future work
  • Also document analysis that doesn't work, so that it can be understood why you choose a particular way of doing the analysis in the end

Where to keep notes

  • Paper Notebook
  • Word processor program / Text files
  • Electronic Lab Notebooks
  • 'Interactive' Electronic Notebooks

R Notebooks

R Notebooks

  • YAML Header
---
title: "R Notebook"
output: html_notebook
---

R Notebooks

  • Text content
    • Markdown

R Notebooks

  • Inline code

Report formats

  • 'Knit' to different output formats
    • html, pdf, word

Hands-on session