AAGI Quarto Templates Extension

AAGI Extension For Quarto

The AAGIQuarto Quarto extension provides official Analytics for the Australian Grains Industry (AAGI) project theming for Quarto documents. If you prefer to use R Markdown, please see the excellent {AAGITemplates} package, which AAGIQuarto has feature parity with and shares the same underlying AAGI templates for the individual AAGI documents so that the outputs should be similar if not identical between these two tools. AAGIQuarto was developed to provide next-generation literate programming tools for AAGI’s reporting and presentation needs that support R, Python and Julia languages.

Please note that due to the nature of the work done in AAGI, AAGIQuarto relies heavily on the R programming language for its templates and so R is expected to be installed if you wish to render the examples and use theming functionality for tables and graphs.

Template Formats

See the included template and demo file for each format here:

Report Formats

AAGI PDF Short Report: AAGI PDF Short Report Demo (Source)
AAGI PDF Report: AAGI PDF Report Demo (Source)
AAGI Word Document Report: AAGI Word Document Demo (Source)
AAGI Word Document Short Report: AAGI Word Document Short Demo (Source)
AAGI HTML Document Report: AAGI HTML Document Demo (Source)
AAGI HTML Document Short Report: AAGI HTML Document Short Demo (Source)

Presentation Formats

AAGI revealjs Presentation: AAGI revealjs Slide Demo (Source) (this is an AAGIQuarto exclusive)
AAGI PowerPoint Presentation: AAGI PPT Slide Demo (Source)

Downloading the Templates

You can download a .zip file of all of these templates for your own use if you would like, you will need to install the AAGIQuarto extension in the root directory where you intend to use it/them.

Installing

Getting Quarto

If you do not have Quarto installed on your device (and are not already using RStudio, which includes it by default), you will need to do that first. Go here for instructions on how to install Quarto.

Getting the Template

Use your terminal or command prompt to run the install commands. Alternatively, if you use RStudio or VS Code (including VSCodium or Positron) you can use the terminal emulator, but not the R, Python, or Julia REPL (read-eval-print-loop console), in those integrated development environments (IDE) to run the commands. Or, if you prefer and you are using Windows, you may need to install the Windows Subsystem for Linux (WSL) to use the bash command. For more information, see Microsoft’s documentation.

You can obtain a copy of the extension by using the following commands in your Bash terminal (CLI):

cd your_quarto_project_folder
quarto use template AAGI-AUS/AAGIQuarto

This will install the extension and create an example qmd file that you can use as a starting place for your LaTeX PDF, MS Word .docx or reveal.js presentation slides.

Getting the Extension

If you wish to use get the extension but not use the supplied default template, you can use the following command:

cd your quarto_project_folder

This will add the AAGIQuarto extension only to the directory and you can create your own Qmd file.

Using the Demo Templates with the Extension

You can also download the zip file of the demo templates and add the extension and use it from there like so:

wget https://aagi-aus.github.io/AAGIQuarto/_files/templates.zip
unzip templates.zip
cd templates
quarto add AAGI-AUS/AAGIQuarto

Using

For documentation on using reveal.js slides in Quarto, please see, https://quarto.org/docs/presentations/revealjs/.

To use the formatted output, save your qmd file into the extension folder that you created using the command above. Then, in the output format use:

aagi-docxreport, for a full length MS Word report
aagi-docxshortreport, for a short MS Word report
aagi-htmlreport, for a full length HTML report
aagi-htmlshortreport, for a short HTML report
aagi-pptx, for MS PPT output
aagi-revealjs, for a revealjs presentation
aagi-pdfreport, for a full length PDF report
aagi-pdfshortreport, for a short PDF report

See all available document formats using quarto use template --list AAGI-AUS/AAGIQuarto.

Template

If you use the Bash command above to install the extension and create a sub directory following the command prompt, there will be a .qmd file created using the name that you input for the sub directory.

By default, these templates use {AAGIThemes} and {AAGIPalettes} for R graphical and tabular outputs.

Updating

As we continue to improve this extension through bug fixes or adding new functionality, you can update it easily like so. Navigate to your Quarto project folder if you aren’t already there:

cd your_quarto_project_folder
quarto update AAGI-AUS/AAGIQuarto

Logo Rights

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