Skip to content

Latest commit

 

History

History
95 lines (67 loc) · 2.91 KB

README.md

File metadata and controls

95 lines (67 loc) · 2.91 KB

Project Status: Active – The project has reached a stable, usable state and is being actively developed. R-CMD-check

{AAGIPalettes} AAGI Colours and Colour Palettes for R

This repository contains the code for the R package {AAGIPalettes}, which once installed in your R session (local or RStudio Server), provides helper functions, data and palettes for working with AAGI colours.

Installation instructions

You can install {AAGIPalettes} like so:

if (!requireNamespace("remotes", quietly = TRUE)) {
  install.packages("remotes")
}
remotes::install_github("AAGI-AUS/AAGIPalettes",
                        dependencies = TRUE
)

Quick start

Following are some quick examples of {AAGIPalettes} functionality.

Official Colours

{AAGIPalette} provides a data object of the official AAGI colours from the comms guide. You can see the hex code values in a named vector like so.

library("AAGIPalettes")

aagi_colours
#> AAGI Bright Green         AAGI Teal         AAGI Blue        AAGI Green 
#>         "#B6D438"         "#00808b"         "#648FD2"         "#54921E" 
#>       AAGI Yellow       AAGI Orange        AAGI Black         AAGI Grey 
#>         "#FFBC42"         "#ec8525"         "#414042"         "#F2F2F2"

Viewing Colours

{AAGIPalette} provides limited functionality for viewing and working with colours. You can plot the colours or palettes in the package as follows.

display_aagi_cols("aagi_colours")

Display the “aagi_BuOr” palette with 9 stops.

display_aagi_cols(name = "aagi_BuOr", n = 9)

Interpolating Colours

library(ggplot2)

x <- interpolate_aagi_colours()
# round the weights to clean up the legend, this is just an e.g. after all...
wt_vals <- x(length(unique(round(mtcars$wt, 1))))

ggplot(mtcars, aes(x = mpg, y = hp, colour = as.factor(round(wt, 1)))) +
geom_point() +
scale_colour_manual("Weight", values = wt_vals)

Logo Rights

The logo of this project and the AAGI strategic partners do not come under MIT License. The Analytics for the Australian Grains Industry (AAGI) project retains full rights to the AGGI logo and the Grains Research and Development Corporation (GRDC) and strategic partners, Curtin University, the University of Queensland and Adelaide University, retain full rights to their own logos, respectively.