blob: e9eed0d32758782ebcf8b7c68e2c7fec8b23775e [file] [log] [blame]
Marc Kupietzd2be7362023-06-14 07:17:27 +02001---
Marc Kupietzc3724852023-06-14 14:20:36 +02002title: Generate Reproducible IDS-CD compliant HTML and PDF Posters
Marc Kupietza39d0cc2024-05-31 12:45:45 +02003subtitle: Using RMarkdown and `posterdown.ids::posterdown_ids`
Marc Kupietzd2be7362023-06-14 07:17:27 +02004author:
5 - name: Brent Thorne
6 affil: 1
7 orcid: '0000-0002-1099-3857'
Marc Kupietzc3724852023-06-14 14:20:36 +02008 - name: Marc Kupietz
Marc Kupietzd2be7362023-06-14 07:17:27 +02009 affil: 2
Marc Kupietzc3724852023-06-14 14:20:36 +020010 orcid: '0000-0001-8997-8256'
Marc Kupietzd2be7362023-06-14 07:17:27 +020011affiliation:
12 - num: 1
13 address: Department of Earth Science, Brock University
14 - num: 2
Marc Kupietzc3724852023-06-14 14:20:36 +020015 address: IDS Mannheim
Marc Kupietzb9bbf202023-06-14 20:10:30 +020016contact:
17 name: Marc Kupietz
18 department: Digital Linguistics
19 email: kupietz@ids-mannheim.de
Marc Kupietzb07481c2023-06-24 10:42:37 +020020 website: "https://www.ids-mannheim.de/digspra/"
Marc Kupietzcbe8b142023-06-24 17:48:20 +020021 qrlink: >
Marc Kupietza39d0cc2024-05-31 12:45:45 +020022 `r posterdown.ids::qrlink('https://korap.ids-mannheim.de/gerrit/plugins/gitiles/IDS-Mannheim/posterdown')`
Marc Kupietz095d7de2023-06-16 08:22:56 +020023column_numbers: 2
Marc Kupietzc3724852023-06-14 14:20:36 +020024# logoright_name: https://raw.githubusercontent.com/brentthorne/posterdown/master/images/betterhexlogo.png
Marc Kupietzd2be7362023-06-14 07:17:27 +020025logoleft_name: https://raw.githubusercontent.com/brentthorne/posterdown/master/images/betterhexlogo.png
26output:
Marc Kupietza39d0cc2024-05-31 12:45:45 +020027 posterdown.ids::posterdown_ids:
Marc Kupietzd2be7362023-06-14 07:17:27 +020028 self_contained: false
Marc Kupietz095d7de2023-06-16 08:22:56 +020029 keep_md: true
Marc Kupietzd2be7362023-06-14 07:17:27 +020030bibliography: packages.bib
Marc Kupietzd97a8cb2023-06-14 20:10:30 +020031csl: "https://raw.githubusercontent.com/ICLC-10/Zotero/master/styles/ICLC-10.csl"
Marc Kupietz095d7de2023-06-16 08:22:56 +020032keep_md: true
Marc Kupietzd2be7362023-06-14 07:17:27 +020033---
34
35```{r setup, include=FALSE}
Marc Kupietzefa616e2023-06-24 10:42:16 +020036library(qrcode)
Marc Kupietzc3724852023-06-14 14:20:36 +020037knitr::opts_chunk$set(dev = 'svg', echo = FALSE)
Marc Kupietzd2be7362023-06-14 07:17:27 +020038```
39
40# Introduction
41
Marc Kupietzd97a8cb2023-06-14 20:10:30 +020042Welcome to `posterdown::ids_poster`! This is my attempt to adapt the `posterdown` R package to the IDS Mannheim corporate design. Most features from R Markdown are available in this package such as Markdown section notation, figure captioning, and even citations like this one [@R-rmarkdown]. The rest of this example poster will show how you can insert typical conference poster features into your own document.
Marc Kupietzd2be7362023-06-14 07:17:27 +020043
44## Objectives
45
Marc Kupietz16cb8bb2023-06-21 11:44:57 +0200461. Easy to use reproducible poster design. [^1]
Marc Kupietzd2be7362023-06-14 07:17:27 +0200472. Integration with R Markdown.
Marc Kupietza39d0cc2024-05-31 12:45:45 +0200483. Easy transition from `posterdown` `pagedown` report or manuscript documents [@R-pagedown] and [revealjs-ids](https://gitlab.ids-mannheim.de/ids/revealjs).
Marc Kupietzd2be7362023-06-14 07:17:27 +020049
Marc Kupietz16cb8bb2023-06-21 11:44:57 +020050[^1]:Footnotes are possible, too.
51
Marc Kupietzd2be7362023-06-14 07:17:27 +020052# Methods
53
54This package uses the same workflow approach as the R Markdown you know and love. Basically it goes from RMarkdown > Knitr > Markdown > Pandoc > HTML/CSS > PDF. You can even use the bibliography the same way [@R-posterdown].
55
Marc Kupietz5625fc72023-06-18 12:12:13 +020056### Bibliography
57
58* for generating references and bibliography Zotero is used
Marc Kupietz59d7b142023-06-21 11:46:56 +020059* in order to produce IDS citation standard compliant bibliographies, put this into your header:
Marc Kupietz5625fc72023-06-18 12:12:13 +020060
61```yaml
62csl: "https://raw.githubusercontent.com/ICLC-10/Zotero/master/styles/ICLC-10.csl"
63```
64
65
Marc Kupietzd2be7362023-06-14 07:17:27 +020066# Results
67
68Usually you want to have a nice table displaying some important results that you have calculated. In `posterdown` this is as easy as using the `kable` table formatting you are probably use to as per typical R Markdown formatting.
69
70You can reference tables like so: Table \@ref(tab:mytable). Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam placerat augue at velit tincidunt semper. Donec elementum porta posuere. Nullam interdum, odio at tincidunt feugiat, turpis nisi blandit eros, eu posuere risus felis non quam. Nam eget lorem odio. Duis et aliquet orci. Phasellus nec viverra est.
71
Marc Kupietzc3724852023-06-14 14:20:36 +020072```{r mytable, out.width='60%'}
73knitr::kable(iris[1:10, 1:3], caption = 'Table caption.',align = 'c',"html")
Marc Kupietzd2be7362023-06-14 07:17:27 +020074```
75
76Or with figures: Figure \@ref(fig:standard-plot), or Figure \@ref(fig:morefigs).
77
78```{r standard-plot, out.width='80%', fig.align='center', fig.cap='Great figure!', fig.height=5}
79plot(mtcars[1:2])
80```
81
Marc Kupietzdcb81cf2023-06-15 08:58:56 +020082```{r morefigs, out.width='80%', echo=TRUE, fig.align='center', fig.cap='Amazing, right?!', fig.height=5}
Marc Kupietzd2be7362023-06-14 07:17:27 +020083data <- iris
84
85plot(x = data$Sepal.Length,
86 y = data$Sepal.Width,
87 col = data$Species,
88 pch = 19,
89 xlab = "Sepal Length (cm)",
90 ylab = "Sepal Width (cm)")
91
92```
93
94# Next Steps
95
96Aliquam sed faucibus risus, quis efficitur erat. Vestibulum semper mauris quis tempus eleifend. Aliquam sagittis dictum ipsum, quis viverra ligula eleifend ut. Curabitur sagittis vitae arcu eget faucibus. In non elementum felis. Duis et aliquam nunc. Nunc pulvinar sapien nunc, vel pretium nisi efficitur in. Fusce fringilla maximus leo et maximus. Fusce at ligula laoreet, iaculis mi at, auctor odio. Praesent sed elementum justo. Aenean consectetur risus rhoncus tincidunt efficitur. Praesent dictum mauris at diam maximus maximus [@R-posterdown].
97
98# Conclusion
99
100Try `posterdown` out! Hopefully you like it!
101
102```{r, include=FALSE}
103knitr::write_bib(c('knitr','rmarkdown','posterdown','pagedown'), 'packages.bib')
104```
105
106# References