Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 3.65 KB

prerequisites.md

File metadata and controls

52 lines (35 loc) · 3.65 KB

Participants should bring a laptop with an up to date Mac, Linux, or Windows operating system (not a tablet, Chromebook, etc.) that they have administrative privileges on. If you have already installed these programs, please make sure you have the most recent versions. If you have questions, please contact us via the gitter chat (bottom right of this page).

Softwares to install

Generally necessary

  • A bash terminal
    For Ubuntu and Mac users, this comes pre-installed.
    For windows users, we encourage you to have a look at the Windows subsytem for linux.
  • Git
    If git is not yet installed on your system, we encourage to have a look at this guide.

!> For Windows users, make sure to tick Git bash install as well

  • Github
    You need a free account for the Website Github. Please register here.

  • Conda We recommend you to install miniconda on your system. The install guide can be found here for Windows, Mac, and Linux

  • Other required softwares will be installed using a conda environment (click here to download)

Once you've downloaded the conda environment, change the directory to where the environment was downloaded (for example download_directory)

cd download_directory

And install the environment using conda

conda env create -f environment.yml

For "Research Compendia with R". If you do not want to install this software, you can also follow this tutorial in an RStudio Cloud session in the browser

  • R
    Windows: Install R by downloading and running this .exe file from CRAN. You will also need to download and install the Rtools software package. Mac: Install R by downloading and running this .pkg file from CRAN.
    Linux: You can download the binary files for your distribution from CRAN. Or you can use your package manager (e.g. for Debian/Ubuntu run sudo apt-get install r-base and for Fedora run sudo dnf install R).

  • RStudio
    Rstudio can be downloaded and installed here. For Windows users: If you have separate user and admin accounts, you should run the installers as administrator (right-click on .exe file and select "Run as administrator" instead of double-clicking). Otherwise problems may occur later, for example when installing R packages.

  • R packages
    R contains an own, operating-system agnostic software package management. You should install the following packages:
    devtools, tidyverse, evaluate, digest, highr, markdown, stringr, yaml, Rcpp, htmltools, knitr, jsonlite, base64enc, mime, rmarkdown install.packages(c("devtools", "tidyverse", "evaluate", "digest", "highr", "markdown", "stringr", "yaml", "Rcpp", "htmltools", "knitr", "jsonlite", "base64enc", "mime", "rmarkdown")) You should finally install the main tool for this tutorial:
    rrtools devtools::install_github("benmarwick/rrtools")