Before you can use the WORCS workflow and the full functionality of the
worcs package, 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 https://CRAN.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.
- Register on ‘GitHub’ (alternatively: see this vignette on how to use ‘GitLab’ or ‘Bitbucket’)
- Go to 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 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 packages required for WORCS 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 [package name], then run the code
- If you are prompted to update packages, just press [ENTER] to avoid updating packages. 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.
install.packages("worcs", dependencies = TRUE)
renv::consent(provided = TRUE)
If you intend to write documents in APA style, you should additionally install the
papaja package. Unfortunately, this package is not yet available on the central R repository CRAN, but you can install it from ‘GitHub’ using the following code:
remotes::install_github("crsh/papaja", dependencies = TRUE, update = "never")
papaja has many dependencies, it is recommended to skip this step if you intend to write documents in a different style than APA.
That’s it! Everything should be installed and connected now.