Skip to content

Instantly share code, notes, and snippets.

@joelnitta
Created July 12, 2021 06:09
Show Gist options
  • Save joelnitta/031d441abc5a8487242bef1ffa5e9328 to your computer and use it in GitHub Desktop.
Save joelnitta/031d441abc5a8487242bef1ffa5e9328 to your computer and use it in GitHub Desktop.
example posterdown document
---
title: "`posterdown`: Generate Reproducible & Live HTML and PDF Conference Posters Using RMarkdown"
author:
- name: Brent Thorne
affil: 1
orcid: '0000-0002-1099-3857'
- name: Another G. Author
affil: 2
affiliation:
- num: 1
address: Department of Earth Science, Brock University
- num: 2
address: Department of Graphics and Layouts, University of Posters; Canada
column_numbers: 3
logoright_name: https://raw.githubusercontent.com/brentthorne/posterdown/master/images/betterhexlogo.png
logoleft_name: https://raw.githubusercontent.com/brentthorne/posterdown/master/images/betterhexlogo.png
output:
posterdown::posterdown_html:
self_contained: false
bibliography: packages.bib
---
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = FALSE)
```
# Introduction
Welcome to `posterdown` ! This is my attempt to provide a semi-smooth workflow for those who wish to take their R Markdown skills to the conference world. 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.
## Objectives
1. Easy to use reproducible poster design.
2. Integration with R Markdown.
3. Easy transition from `posterdown` to `pagedown` report or manuscript documents [@R-pagedown].
# Methods
This 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].
# Results
Usually 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.
You 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.
```{r mytable, out.width='80%'}
knitr::kable(iris[1:10, 1:4], caption = 'Table caption.',align = 'c',"html")
```
Or with figures: Figure \@ref(fig:standard-plot), or Figure \@ref(fig:morefigs).
```{r standard-plot, out.width='80%', fig.align='center', fig.cap='Great figure!', fig.height=5}
plot(mtcars[1:2])
```
```{r morefigs, out.width='80%', echo=TRUE, fig.cap='Amazing, right?!', fig.height=5}
data <- iris
plot(x = data$Sepal.Length,
y = data$Sepal.Width,
col = data$Species,
pch = 19,
xlab = "Sepal Length (cm)",
ylab = "Sepal Width (cm)")
```
# Next Steps
Aliquam 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].
# Conclusion
Try `posterdown` out! Hopefully you like it!
```{r, include=FALSE}
knitr::write_bib(c('knitr','rmarkdown','posterdown','pagedown'), 'packages.bib')
```
# References
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment