Chapter 2 Prerequisites
This GitBook is created in Rstudio, using the bookdown
package. To get your system set up correctly, you have to install several software packages, and register on GitHub. You only have to perform these steps once, and the entire process should take approximately 1 hour if you start from scratch. In case some software is already installed on your system, you can skip related steps. Follow these steps in order:
- Install R from cloud.r-project.org
- Install Rstudio Desktop (Free) from rstudio.com
- Install Git from git-scm.com. Use the default, recommended settings. It is especially important to leave these settings selected:
- Git from the command line and also from third party software
- Use the OpenSSL library
- Checkout Windows-style, commit Unix-style line endings
- Enable Git Credential Manager
- If you run into any trouble, a more comprehensive tutorial on installing Git is available at happygitwithr.com.
- Git from the command line and also from third party software
- Register on GitHub
- Go to https://github.com/ and click “Sign up”. Choose an “Individual”, “Free” plan.
- Request a free academic upgrade. This allows you to create private repositories, which are only visible to you and selected collaborators, and can be made public when your work is published.
- Connect Rstudio to Git and Github (for more support, see this Rstudio article, and this blog post)
- Open Rstudio, open the Tools menu, click Global Options, and click Git/SVN
- Verify that Enable version control interface for RStudio projects is selected
- Verify that Git executable: shows the location of git.exe. If it is missing, manually fix the location of the file.
- Click Create RSA Key. Do not enter a passphrase. Press Create. A window with some information will open, which you can close.
- Click View public key, and copy the entire text to the clipboard.
- Close Rstudio (it might offer to restart by itself; this is fine)
- Go to https://github.com
- Click your user icon, click Settings, and then select the SSH and GPG keys tab.
- Click New SSH key. Give it an arbitrary name (e.g., your computer ID), and paste the public key from your clipboard into the box labeled “Key”.
- Open Rstudio again (unless it restarted by itself)
- Install all required packages by running the following code in the Rstudio console. Be prepared for three contingencies:
- If you receive any error saying There is no package called XYZ, then run the code
install.packages("XYZ")
- If you are prompted to update packages, just press
3: None
. Updating packages this way in an interactive session sometimes leads to errors, if the packages are loaded.
- If you see a pop-up dialog asking Do you want to install from sources the package which needs compilation?, click No. If this leads to errors, then please follow Step 3 from this online guide, and run
install.packages("devtools")
. This will take a long time, but will allow you to install packages from source.
- If you receive any error saying There is no package called XYZ, then run the code
Run the following code to install the required packages:
install.packages("bookdown")
install.packages("tinytex")
tinytex::install_tinytex()
git2r::config(global = TRUE, user.name = "your.name", user.email = "your.email")
That’s it! Everything should be installed and connected now.