README.md

In adamhsparks/theme_usq: USQ Themed Plots for Base Graphics and 'ggplot2'

theme.usq

theme.usq is Unsupported

I have ceased all development and support for this R package. If you work at USQ and wish to take over the maintenance and development of this package, feel free to contact me and let me know. You can open an issue here to do this and ask me to transfer the repository to you.

Introduction to theme.usq

The goal of theme.usq is to provide University of Southern Queensland (USQ) staff and students a quick and easy way to apply USQ colours and typography to graphs created in R using the base graphics package or ggplot2 while providing clear graphs for reports and presentations. All of the colours provided are defined in USQ’s Visual Identity Colour Palette and follow the order in the PowerPoint Corporate templates.

This package has been tested on macOS, Ubuntu Linux and USQ computers using Windows 10. For Linux users, if you have not installed the MS Core Fonts, you will need to do that for this package to function properly and generate the graphs with the proper typography. Windows and macOS users should be ready to go with just the installation of this package.

Quickstart

If you do not already have R installed, because theme.usq is an R package, you will need to install R first. Download and install the proper version for your computer from CRAN. It is also suggested to have RStudio installed as well. You can download the proper installation file from https://www.rstudio.com/products/rstudio/download/ for your platform.

Once R and RStudio are set up, you’re ready to install theme.usq through an R session.

The theme.usq package is only available from GitHub. The easiest way to install it is by using the remotes package.

The installation may take some time as some system fonts need to be catalogued to use the Microsoft Verdana font that USQ suggests. Once the installation is complete, it should not be necessary to re-catalogue the fonts, so loading theme.usq will not take any longer than expected.

To install theme.usq copy and paste the code in the following code block in your R session console.

if(!require(remotes)){
    install.packages("remotes")
    library(remotes)
}

install_github("adamhsparks/theme.usq",
               dependencies = TRUE,
               build_vignettes = TRUE)

library("ggplot2")
library("theme.usq")

Keeping theme.usq up-to-date

Since theme.usq is still under development with bug fixes and new features being added and it is not available from CRAN; update.packages() will not update it. To keep theme.usq updated, use:

remotes::update_packages("theme.usq")

Examples of how to use theme.usq can be found in the vignette, e.g., vignette("theme.usq") and online, https://adamhsparks.github.io/theme.usq/articles/theme.usq.html.

Meta

• Please report any issues or bugs.

• License: MIT

• Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

adamhsparks/theme_usq documentation built on Nov. 18, 2020, 3:50 a.m.