-
Notifications
You must be signed in to change notification settings - Fork 2
/
template.qmd
179 lines (130 loc) · 4.21 KB
/
template.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
---
format:
# Delete the format that you don't want
# Presentation
aagi-revealjs: default
aagi-pptx: default
# Report
aagi-pdf+report: default # full length pdf report
aagi-pdf+short+report: default # short pdf report (typically one page)
aagi-docx+report: default # full length word docx report
aagi-docx+short+report: default # short word docx report (typically one page)
execute:
echo: false
# Delete these if you're using the template for presentation
knitr:
opts_chunk:
fig.path: figures/
params:
# All the params can be changed to align to your organisation and collaborator.
# These can be changed here or in the terminal using the following command with
# each -P represents a parameter:
# quarto render ... -P $params$:... -P $params2$:///
uni: CU
pri_bio: Your.Name
project_num: AAA--BBB
partner: collab_partner
partner_email: collab_partner@email.com.au
date: "`r Sys.Date()`"
date-format: long
bibliography: your_references.bib # Replace with your .bib file
---
```{r}
#| include: false
#| label: variable-based-on-param
if (params$uni == "CU") {
project_lead = "Curtin University -- Prof Mark Gibberd, Dr Julia Easton, Prof Adam Sparks"
email = "cbada@curtin.edu.au"
university <- "Curtin University"
} else if (params$uni == "UA") {
project_lead = "University of Adelaide -- Dr Julian Taylor, Dr Olena Kravchuck"
email = paste(params$pri_bio, "@adelaide.edu.au", sep = "")
university <- "University of Adelaide"
} else {
project_lead = "University of Queensland -- Prof Scott Chapman, Emeritus Prof Kaye Basford"
email = paste(params$pri_bio, "@uq.edu.au")
university <- "University of Queensland"
}
```
---
title: "Analytics for the Australian Grains Industry - `r university` (AAGI-`r params$uni`) \n Technical Report Series: 123"
subtitle: "Descriptive title for report \n Report for `r params$project_num`"
author:
- "Prepared for: `r params$partner` (`r params$partner_email`)"
- "Prepared by: `r params$pri_bio`, Author 2"
- "Project Lead: `r project_lead`"
email: "`r email`"
---
```{r}
#| label: install-load-aagi-theme
#| include: false
# Install the {pak} package to install AAGI package
if(!requireNamespace("pak", quietly = TRUE)){
install.packages("pak")
}
# {flextable} can be used for both word and pdf output
if(!require(flextable)){
install.packages("flextable")
}
if(!require(AAGIThemes)){
pak::pkg_install(
"AAGI-AUS/AAGIThemes",
dependencies = TRUE, upgrade = TRUE
)
}
if(!require(AAGIPalettes)){
pak::pkg_install(
"AAGI-AUS/AAGIPalettes",
dependencies = TRUE, upgrade = TRUE
)
}
```
```{r}
#| label: set-the-default-layout
#| include: false
library(flextable)
library(ggplot2)
library(AAGIThemes)
library(AAGIPalettes)
# set ggplot2 theme
theme_set(theme_aagi())
# set flextable theme
set_flextable_defaults(
theme_fun = theme_ft_aagi
)
```
# To compile a presentation, please see:
- Revealjs: <https://quarto.org/docs/presentations/revealjs/>
- PowerPoint: <https://quarto.org/docs/presentations/powerpoint.html>
# Executive summary
What was provided by AAGI and the main results?
# Introduction
- Goals of the research project.
- Background, context and rationale behind the research.
# Experimental/Trial Design
- Trial design type and layout.
- Treatments, number of replicates.
- Specific considerations for small plots, glasshouse, genetics, breeding trials, OFE projects, or bioinformatics.
# Exploratory Data Analysis and Data Visualisation
- Interpretation of plots and data.
- Rationale behind specific methods used.
# Methods
- Detailed description of the procedures and methodologies used.
- Include versions/commits on developed pipelines, scripts, and input/output details if applicable.
# Analysis (if separate from Methods)
Approach taken for data analysis.
# Results and Discussion
Findings and their implications.
# Metadata and Datasets (Optional)
- md5sums for input data and outputs (if applicable).
- Git commit numbers and tags.
- Location of outputs (FAIR Data).
- DOI for AAGI outputs.
# Map (Location, Optional)
Include if relevant to the project.
# References
Cited works and literature.
::: {#refs}
:::
# Appendix (Optional)
Additional supporting information.