This vignette provides an overview of how to install cmapplot, with a specific focus on CMAP-issued computers. This guide presumes that the user does not have administrator privileges.
Your CMAP computer should already have both R and RStudio installed. If it does not, please submit an IT helpdesk request to install them. (While you can install RStudio on your own by downloading the .zip – not .exe – version, installing R itself requires administrator privileges).
Once you have working versions of R and RStudio on your computer, you will also need to download an additional utility called Rtools. You can download the installation file for Rtools here. Because of IT restrictions, you will need to choose an installation folder that you have write access to. The Rtools installer defaults to C:\rtools40, which is fine. However, if you do not want to install it there, you may create another folder in your own user sub-directory (e.g. C:\Users\your_username\rtools).
Finally, before you can install cmapplot, you will need to download and install the “devtools” and “tidyverse” packages. You can install them by running the following code in RStudio:
## Install devtools & tidyverse
install.packages(c("devtools", "tidyverse"))Once you have successfully downloaded and installed Rtools and the “devtools” and “tidyverse” packages, you are ready to install cmapplot. Run the following code to install and load cmapplot:
## Install/update cmapplot from GitHub
devtools::install_github("CMAP-REPOS/cmapplot", build_vignettes=TRUE)
## Load cmapplot
library(cmapplot)After completing these steps, your computer should be ready to use and export graphics using cmapplot.
CMAP’s design standards require the usage of the Whitney typeface. Whitney is not freely available, but rather requires a license. On CMAP computers, which should already have the Whitney font family installed, cmapplot will use Whitney without any issues. If you receive a warning that Whitney is not installed when you load the package, please verify that the Whitney fonts (specifically, the Book, Medium and Semibold variants) are installed. If they are not, please submit an IT helpdesk request to get them installed. If the Whitney font family is already installed and you are receiving the warning message, please reach out to a member of the cmapplot development team.
Non-CMAP users will have to license Whitney on their own, or else use cmapplot without. The package will default to your system’s default sans-serif font, which is likely Arial.