VickySteeves/repro-papers


https://vickysteeves.gitlab.io/repro-papers


Writing reprocible geoscience papers using R Markdown, Docker, and GitLab

This repository contains the course material for the EGU General Assembly 2018 short course "Writing reprocible geoscience papers using R Markdown, Docker, and GitLab". It is co-organised by Daniel Nüst, Vicky Steeves, Markus Konkol, and Edzer Pebesma.

Internals

This course website is based on the bookdown package, built automatically with the GitLab CI (see file .gitlab-ci.yml and work by Romain Lesur and available online in various formats: LINK HERE

You can build the page and all output formats locally with

install.packages("bookdown")
library("bookdown")
bookdown::render_book("index.Rmd", "all", output_dir = "public")

Or just use the "Build" > "Build Book" - Button in RStudio.

Structure

Instructions partly based on A minimal book example using bookdown.

  • Each Rmd file contains one and only one chapter, and a chapter is defined by the first-level heading #.
  • Each sentence is on a seperate line to improve git merges and change tracking.
  • packages.bib includes a bib database for R packages; it can be created with the command below.
knitr::write_bib(c(
  .packages(), 'bookdown', 'knitr', 'rmarkdown', 'rticles'
), 'packages.bib')
  • Write citations for packages, e.g. [@R-bookdown] and papers, e.g. [@xie2015].
  • Label chapters and sections using {#label} in the headlines and reference as \@ref(label).

Project Statistics

Sourcerank 2
Stars 0
Forks 3
Open issues 6
Dependencies 0
Tags 0
Created
Last updated

Something wrong with this page? Make a suggestion

Last synced: 2019-09-13 22:12:58 UTC

Login to resync this repository