Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 5.07 KB

README.md

File metadata and controls

44 lines (29 loc) · 5.07 KB
Raw

Supporting Information

This repository holds all supplementary source code needed to reproduce the calculations and plots of the following publication:

Silverman SN, Kopf SH, Bebout BM, Gordon R, Som SM. Morphological and isotopic changes of heterocystous cyanobacteria in response to N2 partial pressure. Geobiology. 2018;00:1-16. https://doi.org/10.1111/gbi.12312

The fully compiled analysis files are available as HTML reports. For the easiest way to run the source R Markdown (.Rmd) files that produce these HTML reports yourself along with the data figures in PDF and PNG format and the data tables in XLSX format, please follow the instructions below.

What is R Markdown?

R Markdown is a so-called "literate programming" format that enables easy creation of dynamic documents with the R language. HTML and PDF reports can be generated from R Markdown files using knitr and pandoc, which can be installed automatically with RStudio, and are fully integrated into this cross-platform IDE. All software used for these reports (R, RStudio, etc.) is freely available and completely open-source.

How can I run this code?

Option 1: Run it in the cloud using binder

  1. Use the following link to load this entire repository and all its dependencies in an online RStudio instance: Binder (note that this may take a few minutes to launch).
  2. Open any of the R Markdown (.Rmd) files in the file browser
  3. To generate an HTML report ("knit HTML"), select File --> Knit from the menu. The HTML report will be displayed upon successful completion (it might take a minute or two for files with more complex calculations or figures) and is saved as a standalone file in the same directory (these are the files made available online and linked in the SI). All generated data figures are saved as PDF and PNG in the figures sub-directory. All generated data tables are saved as XLSX in the tables sub-directory.
  4. Make sure to download any edited or generated files you want to keep. They will disappear once you close the binder instance (or once it gets terminated due to inactivity).

Option 2: Run it on your desktop

The quickest and easiest way is to use RStudio.

  1. Download and install R for your operating system
  2. Download and install RStudio for your operating system
  3. Download a zip file of this repository and unpack it in an easy to find directory on your computer
  4. Navigate to the directory and double-click the project.Rproj file to start RStudio and load this project.
  5. Install the required libraries by running the following command in the Console in RStudio: install.packages(c("rmarkdown", "tidyverse", "readxl", "openxlsx", "knitr", "latex2exp", "boot", "broom", "devtools")) or by installing them manually in RStudio's Packages manager.
  6. Install the pre-release IRMS data libraries isoreader and isoprocessor by running the following commands in the Console in RStudio:
    • devtools::install_github("Kopflab/isoreader", ref = "v2018_Silverman")
    • devtools::install_github("Kopflab/isoprocessor", ref = "v2018_Silverman")
  7. Open any of the R Markdown (.Rmd) files in the file browser
  8. To generate an HTML report ("knit HTML"), select File --> Knit from the menu. The HTML report will be displayed upon successful completion (it might take a minute or two for files with more complex calculations or figures) and is saved as a standalone file in the same directory (these are the files made available online and linked in the SI). All generated data figures are saved as PDF and PNG in the figures sub-directory. All generated data tables are saved as XLSX in the tables sub-directory.

What can I do with this code?

We hope that this code, or any part of it, might prove useful to other members of the scientific community interested in the subject matter. All code is completely open-access and can be modified and repurposed in every way. If significant portions are reused in a scientific publication, please consider citing our work. Please make sure to cite this work if re-using any of our data.

Troubleshooting notes

The R Markdown files in this repository make use of various R modules for data processing, plotting and modelling. All of these should be installed automatically when the first R Markdown file is knitted (if the knitting fails because of a missing package, please install it manually, an error will indicate which package could not be installed).