Skip to main content
Advertisement

< Back to Article

A simple kit to use computational notebooks for more openness, reproducibility, and productivity in research

Fig 3

Comparison between the Rnotebook file available for editing (A) and the rendered html version (B).

The function in set_kit.R creates an.Rmd file (A) with basic metadata (title and minimal formatting of the rendered file), a brief tutorial on the Markdown syntax, paths to the most relevant folders, and suggestions of use. In the.html version (B), one can see how text and code are converted and combined, as well as a couple of features available in Rnotebooks: a table of contents, just below the title (defined by the toc argument set to true in the YAML section of the Rnotebook file), and a code button, that hides the blocks of code by default, to facilitate reading (defined by the code_folding argument set to hide in the YAML section). The video accompanying this tutorial details how the document works (available in https://github.com/FellowsFreiesWissen/computational_notebooks).

Fig 3

doi: https://doi.org/10.1371/journal.pcbi.1010356.g003