Data

Tools

Indexes

Applications

Experiments

Open Source Science

aagithemes

AAGI Branding for R Graphical and Tabular Outputs

https://github.com/aagi-aus/aagithemes

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (19.8%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

AAGI Branding for R Graphical and Tabular Outputs

Basic Info
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 1
  • Open Issues: 4
  • Releases: 0
Created about 2 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog Contributing License Codemeta

README.Rmd 

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```


[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![R-CMD-check](https://github.com/AAGI-Org-AU-Public/AAGIThemes/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/AAGI-Org-AU-Public/AAGIThemes/actions/workflows/R-CMD-check.yaml)


# {AAGIThemes} AAGI Branding for R Graphical and Tabular Outputs 

This repository contains the code for the R package {AAGIThemes}, which once installed in your R session (local or RStudio Server), provides helper functions for creating and exporting graphics created in R with a unified style that follows the AAGI brand guidelines.

The goal of {AAGIThemes} is to provide easy to use theming of R graphics for AAGI team members.
Following AAGI's brand guidelines, AAGI colours are used where applicable and the font defaults to Proxima Nova.
The resulting graphs, plots and charts feature a x and y axis that meet at 0 with no gridlines, but these can optionally be set to appear.

## Installation instructions

{AAGIThemes} is available through the [R-Universe](https://r-universe.dev/search) with pre-built binaries (this is the easy way).

To get started:

### Enable this universe

```r
options(repos = c(
    aagi_aus = 'https://aagi-aus.r-universe.dev',
    CRAN = 'https://cloud.r-project.org'))
```

### Install

```r
install.packages("AAGIThemes")
```

## Quick start

Following are some quick examples of {AAGIThemes} functionality.
However, you may wish to browse the vignette for a more detailed look at what the package offers using:

```r
vignette("AAGIThemes", package = "AAGIThemes")
```

### Create tabular outputs

{AAGIThemes} provides [{flextable}](https://davidgohel.github.io/flextable/) and [{gt}](https://gt.rstudio.com) themes suited for the AAGI style that works in HTML and Word document outputs.

#### Creating Themed {flextable} Outputs

You can use it like so with {flextable}.

```r
library(AAGIThemes)
library(dplyr)
library(flextable)

flextable(head(airquality)) |>
  mutate(`Month Name` = "May") |>
  theme_ft_aagi()
```

### Plots and graphs

{AAGIThemes} provides several functions to assist users in creating plots, charts and graphs with a more unified AAGI style.

For creating standalone graphs using R's base library there are:

  * `barplot_aagi()`,

  * `boxplot_aagi()`,

  * `hist_aagi()`, and

  * `plot_aagi()`.

#### Using the basic plot functions

Example of how the base graphics functionality with AAGI style pre-applied is used:

```{r boxplot_aagi, fig.cap="An example plot illustrating the use of AAGIThemes with R's base plot capabilities."}
library(AAGIThemes)
boxplot_aagi(decrease ~ treatment,
  data = OrchardSprays,
  xlab = "treatment",
  ylab = "decrease"
)
```

See the respective function's help files and the {AAGIThemes} cookbook for more examples and documentation.

#### Using With {ggplot2}

The function `theme_aagi()` is provided to apply a unified style for creating AAGI themed plots, charts and graphs using {ggplot2}.
The function is very basic and provides only one parameter, `base_size`, which is used to set the font size (in points) used in the resulting figure.
No adjustments are made by the type of graph being produced, so you may wish to add grid lines or change the colour palette that is used to alter point or line colours in your graph.

Example of how `theme_aagi()` is used in a standard {ggplot2} workflow:

```{r theme_aagi_ggboxplot, fig.cap="An example plot illustrating the use of AAGIThemes with ggplot2."}
library(AAGIThemes)
library(ggplot2)

ggplot(data = OrchardSprays, aes(x = treatment, y = decrease)) +
  geom_boxplot() +
  scale_y_continuous(breaks = seq(0, 120, by = 20)) +
  theme_aagi()
```

### Maps

Example of a map made with {ggplot2} and {AAGIThemes}.

```{r theme_aagi_map, fig.cap="An example map illustrating the use of AAGIThemes with ggplot2."}
library(AAGIThemes)
library(AAGIPalettes)
library(ggplot2)
library(ozmaps)

sf_oz <- ozmap_data("states")

ggplot(sf_oz, aes(fill = NAME)) +
  geom_sf() +
  coord_sf(crs = "+proj=lcc +lon_0=135 +lat_0=-30 +lat_1=-10 +lat_2=-45 +datum=WGS84") +
  scale_fill_manual(values = unname(palette.colors(palette = "Okabe-Ito"))) +
  theme_aagi()
```

## 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.

Owner

  • Name: Analytics for the Australian Grains Industry
  • Login: AAGI-AUS
  • Kind: organization
  • Email: aagi@uq.edu.au
  • Location: Australia

CodeMeta (codemeta.json) 

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "AAGIThemes",
  "description": "Applies Analytics for the Australian Grains Industry ('AAGI') external brand guidelines to graphics. 'AAGI' colours and font guidelines are applied as useful and reasonable to base graphics, 'ggplot2' figures, 'flextable' and 'gt' objects.",
  "name": "AAGIThemes: AAGI Branding for Graphical and Tabular Outputs",
  "relatedLink": "https://AAGI-AUS.github.io/AAGIThemes/",
  "codeRepository": "https://github.com/AAGI-AUS/AAGIThemes",
  "issueTracker": "https://github.com/AAGI-AUS/AAGIThemes/issues",
  "license": "https://spdx.org/licenses/GPL-3.0",
  "version": "0.0.1",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.5.1 (2025-06-13)",
  "author": [
    {
      "@type": "Person",
      "givenName": "Adam H.",
      "familyName": "Sparks",
      "email": "adam.sparks@curtin.edu.au",
      "@id": "https://orcid.org/0000-0002-0061-8359"
    },
    {
      "@type": "Person",
      "givenName": "Kenyon",
      "familyName": "Ng",
      "email": "kenyon.ng@dpird.wa.gov.au",
      "@id": "https://orcid.org/0000-0002-6315-9831"
    },
    {
      "@type": "Person",
      "givenName": "Tinula",
      "familyName": "Kariyawasam",
      "email": "tinula.kariyawasam@dpird.wa.gov.au"
    },
    {
      "@type": "Person",
      "givenName": "Matt",
      "familyName": "Cowgill",
      "email": "matthew.cowgill@grattaninstitute.edu.au"
    },
    {
      "@type": "Person",
      "givenName": "Will",
      "familyName": "Mackey",
      "email": "william.mackey@grattaninstitute.edu.au"
    }
  ],
  "contributor": [
    {
      "@type": "Person",
      "givenName": "Jimmy",
      "familyName": "Ng",
      "email": "jimmy.ng@dpird.wa.gov.au"
    }
  ],
  "copyrightHolder": [
    {
      "@type": "Organization",
      "name": "Curtin University"
    },
    {
      "@type": "Organization",
      "name": "Grains Research and Development Corporation"
    }
  ],
  "funder": [
    {
      "@type": "Organization",
      "name": "Curtin University"
    },
    {
      "@type": "Organization",
      "name": "Grains Research and Development Corporation"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Adam H.",
      "familyName": "Sparks",
      "email": "adam.sparks@curtin.edu.au",
      "@id": "https://orcid.org/0000-0002-0061-8359"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "dplyr",
      "name": "dplyr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=dplyr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "gapminder",
      "name": "gapminder",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=gapminder"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "version": ">= 1.22",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "ozmaps",
      "name": "ozmaps",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=ozmaps"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "RColorBrewer",
      "name": "RColorBrewer",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=RColorBrewer"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "reshape2",
      "name": "reshape2",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=reshape2"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "roxyglobals",
      "name": "roxyglobals",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=roxyglobals"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rsvg",
      "name": "rsvg",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rsvg"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "sf",
      "name": "sf",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=sf"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "spelling",
      "name": "spelling",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=spelling"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 3.0.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "tibble",
      "name": "tibble",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=tibble"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "viridis",
      "name": "viridis",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=viridis"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "R",
      "name": "R",
      "version": ">= 4.0.0"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "AAGIPalettes",
      "name": "AAGIPalettes",
      "sameAs": "https://github.com/AAGI-AUS/AAGIPalettes"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "cli",
      "name": "cli",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=cli"
    },
    "4": {
      "@type": "SoftwareApplication",
      "identifier": "flextable",
      "name": "flextable",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=flextable"
    },
    "5": {
      "@type": "SoftwareApplication",
      "identifier": "ggplot2",
      "name": "ggplot2",
      "version": ">= 3.3.5",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=ggplot2"
    },
    "6": {
      "@type": "SoftwareApplication",
      "identifier": "grDevices",
      "name": "grDevices"
    },
    "7": {
      "@type": "SoftwareApplication",
      "identifier": "grid",
      "name": "grid"
    },
    "8": {
      "@type": "SoftwareApplication",
      "identifier": "gt",
      "name": "gt",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=gt"
    },
    "9": {
      "@type": "SoftwareApplication",
      "identifier": "magick",
      "name": "magick",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=magick"
    },
    "10": {
      "@type": "SoftwareApplication",
      "identifier": "officer",
      "name": "officer",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=officer"
    },
    "11": {
      "@type": "SoftwareApplication",
      "identifier": "scales",
      "name": "scales",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=scales"
    },
    "12": {
      "@type": "SoftwareApplication",
      "identifier": "showtext",
      "name": "showtext",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=showtext"
    },
    "13": {
      "@type": "SoftwareApplication",
      "identifier": "sysfonts",
      "name": "sysfonts",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=sysfonts"
    },
    "14": {
      "@type": "SoftwareApplication",
      "identifier": "systemfonts",
      "name": "systemfonts",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=systemfonts"
    },
    "15": {
      "@type": "SoftwareApplication",
      "identifier": "withr",
      "name": "withr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=withr"
    },
    "SystemRequirements": null
  },
  "applicationCategory": "Tools",
  "isPartOf": "https://grdc.com.au/research/partnerships-and-initiatives/strategic-partnerships/aagi",
  "fileSize": "4475.589KB",
  "releaseNotes": "https://github.com/AAGI-AUS/AAGIThemes/blob/master/NEWS.md",
  "readme": "https://github.com/AAGI-AUS/AAGIThemes/blob/main/README.md",
  "contIntegration": "https://github.com/AAGI-Org-AU-Public/AAGIThemes/actions/workflows/R-CMD-check.yaml",
  "developmentStatus": "https://www.repostatus.org/#active"
}

GitHub Events

Total
  • Issues event: 1
  • Issue comment event: 3
  • Push event: 77
Last Year
  • Issues event: 1
  • Issue comment event: 3
  • Push event: 77

Dependencies

DESCRIPTION cran
  • R >= 4.0.0 depends
  • ggplot2 >= 3.3.5 imports
  • grDevices * imports
  • grid * imports
  • magick * imports
  • rlang * imports
  • scales * imports
  • showtext * imports
  • sysfonts * imports
  • systemfonts * imports
  • withr * imports
  • RColorBrewer * suggests
  • dplyr * suggests
  • gapminder * suggests
  • knitr >= 1.22 suggests
  • reshape2 * suggests
  • rmarkdown * suggests
  • rsvg * suggests
  • sf * suggests
  • spelling * suggests
  • testthat >= 3.0.0 suggests
  • tibble * suggests
  • viridis * suggests