This is a tutorial on how to set up your personal computer for use
worcs package. It guides you through the
installation of several software packages, and registration on GitHub.
This vignette does not assume a prior installation of
it is suitable for novice users. You only have to perform these steps
once for every computer you intend to use
worcs on, and the entire process should take approximately
30 minutes if you start from scratch. In case some of the software is
already installed on your system, you can skip those related steps.
Follow these steps in order:
usethis::create_github_token(). This should open a webpage with a dialog that allows you to create a Personal Access Token (PAT) to authorize your computer to exchange information with your GitHub account. The default settings are fine; just click “Generate Token” (bottom of the page).
gitcreds::gitcreds_set(). This should open a dialog in the R console that allows you to paste the PAT from your clipboard.
install.packages("worcs", dependencies = TRUE) tinytex::install_tinytex() renv::consent(provided = TRUE)
If you do not have a Git user set up on your computer yet (e.g., if this is the first time you will be using Git), run the following - making sure to substitute your actual username and email:
worcs::git_user("your_name", "your_email", overwrite = TRUE)
If you intend to write documents in APA style, you should
additionally install the
papaja package. Because
papaja has many dependencies, it is recommended to skip
this step if you intend to write documents in a different style than
APA. Unfortunately, this package is not yet available on the central R
repository CRAN, but you can install it from ‘GitHub’ using the
install.packages("papaja", dependencies = TRUE, update = "never")
Everything should be installed and connected now. You can verify your
installation using the convenience function
worcs::check_worcs_installation(). It will run a test suite
and print the results; in case any tests fail, it will provide a hint
for how to resolve it: