blob: b035b15194f8e9ca8a08db10c911c8b439d8a7c8 [file] [log] [blame]
brentthorne1b51ada2019-01-19 16:47:43 -05001---
2#----ESSENTIALS----#
3title: '\fontfamily{phv}\selectfont Using posterdown to generate reproducible conference posters via RMarkdown > Knitr > Markdown > Pandoc > Latex > PDF workflow'
4author: "Author One^1^ Author Two^2^"
5affiliation: "^1^Department of Poster Layouts, University of Markdown; ^2^Deparment of Another Institution, Institution University"
6
7#----FONT STYLE----#
8font_size: "30pt" #sets '\normalsize' (sizes of the title and sections headings will adjust based on it)
9font_family: "palatino" # choose from typical latex fonts (example: "palatino")
10
11#----COLOURS----#
12
13#Background/ Line Colours
14title_bgcol: "0b4545" #Hex colour for background of poster title section (default is blue)
15poster_bgcol: "ffffff" #colour of the poster main background
16cite_col: "CC0000" #colour of ciation elements
17url_col: "008080" #colour of url links
18link_col: "008080" #colour of other links within the poster
19columnline_col: "0b4545" #colour
20header_bgcol: "008080"
21
22#Text Colours
23title_textcol: "ffffff" #colour of title text
24author_textcol: "008080" # Colour of author text
25affiliation_textcol: "FFFFFF" # Colour of affiliation text
26body_textcol: "000000" # Colour of main text in the body of poster
27header_textcol: "CC0000" # Colour of the poster header titles
28footnote_textcol: "FFFFFF" # Colour of footnote text if used
29
30#----POSTER SIZE & COLUMN FORMATTING----#
31poster_height: "38in" # height in inches of poster
32poster_width: "45in" # width in inches of poster
33column_numbers: 3 # Number of columns that the poster has
34column_margins: "10mm" # Margin spacing for columns
35
36#----OTHER----#
37bibliography: MyLibrary # name of the .bib file used for referencing
38output: posterdown::posterdown_pdf
39---
40
41```{r, include=FALSE}
42knitr::opts_chunk$set(echo = FALSE, results = 'asis',fig.height = 3.5, fig.width = 4.5, out.width = "100%", warning = FALSE, fig.align = 'center', message = FALSE, dev='cairo_pdf')
43```
44
45<!--
46Bellow you will find typical RMarkdown syntax which should fill in the columns for the poster from top to bottom left to right. The more information you have the more will be filled. Please let me know if you have feedback at brentthorne18@gmail.com or at github.com/brentthorne/posterdown
47
48ENJOY! XD
49-->
50
51# Introduction
52
53Welcome to `posterdown` ! This is my attempt to provide a semi-smooth workflow for those who wish to take their `RMarkdown` skills to the conference world. Many creature comforts from `RMarkdown` are available in this package such as `Markdown` section notation, figure captioning, and even citations like this one [@holden_identifying_2012] The rest of this example poster will show how you can insert typical conference poster features into your own document.
54
55# Study Site
56
57Here is a map made to show the study site using `ggplot2`, `ggspatial`, and `sf`. Lorem ipsum dolor sit amet, [@middleton_geological_nodate] consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Phasellus vestibulum lorem sed risus ultricies tristique nulla. Mauris vitae ultricies leo integer malesuada nunc vel risus commodo. Suspendisse potenti nullam ac tortor vitae. Enim nunc faucibus a pellentesque sit amet porttitor eget.
58
59```{r, fig.width=4.5, out.width="80%", fig.cap='This is a map of Canada, the ggspatial package is great for GIS folks in R!', cache=TRUE}
60library(ggplot2)
61library(ggspatial)
62library(ggthemes)
63library(sf)
64
65canada <- read_sf("data/Canada.geojson")
66
67ggplot() +
68 ggspatial::layer_spatial(canada, fill = "grey") +
69 ggspatial::annotation_north_arrow(location = "br", which_north = "true", style = north_arrow_nautical()) +
70 coord_sf() +
71 theme_solarized() +
72 NULL
73```
74
75
76# Objectives
77
78\large
79
801. Easy to use reproducible poster design.
812. Integration with `RMarkdown`.
823. Easy transition from `posterdown` to `thesisdown` or `rticles`
83
84\small
85
86# Methods
87
88This package uses the same workflow approach as the `RMarkdown` you know and love. Basically it goes from RMarkdown > Knitr > Markdown > Pandoc > Latex > PDF
89
90# Results
91
92Usually you want to have a nice table displaying some important results that you have calcualated. In posterdown this is as easy as using the `kable` table formatting you are probably use to as per typical `RMarkdown` formatting. I suggesting checking out the `kableExtra` package and its in depth documentation on customizing these tables found [here](https://haozhu233.github.io/kableExtra/awesome_table_in_pdf.pdf).
93
94```{r}
95library(kableExtra)
96library(ggplot2)
97
98data("iris")
99
100kable(iris[1:4,],align = "c", caption = "Tables are a breeze with Kable and Kable extra package!", booktabs = TRUE) %>%
101 kable_styling(latex_options = c("striped","HOLD_position"),full_width = TRUE, font_size = 25)
102
103```
104
105\vspace{1in}
106
107```{r, out.width='75%', fig.width=4, fig.height=3, fig.cap='A typical plot using ggplot using the classic iris dataset.'}
108
109library(ggplot2)
110library(ggthemes)
111
112ggplot(data = iris, aes(x = Sepal.Length, y = Sepal.Width, colour = Species)) +
113 geom_point() +
114 theme_fivethirtyeight() +
115 labs(x = "Sepal Length", y = "Sepeal Width") +
116 NULL
117
118```
119
120\vspace{1in}
121
122```{r, out.width='85%', fig.width=4.5, fig.height=4, fig.cap='Another typical plot using ggplot, this time with a different theme and r code chunk options for fig.width and fig.height.'}
123
124library(ggplot2)
125library(ggthemes)
126
127ggplot(data = iris, aes(x = Sepal.Length, y = Sepal.Width, colour = Species)) +
128 geom_point() +
129 theme_hc() +
130 labs(x = "Sepal Length", y = "Sepeal Width") +
131 NULL
132
133```
134
135\vspace{1in}
136
137```{r, out.width='80%', fig.width=4.5, fig.align='center', echo=TRUE, fig.height=5, fig.cap='Another figure showing how base R plots might look on this poster!'}
138
139# Here is some code for people
140# to look at and be in awe of!!!!
141library(ggplot2)
142library(ggthemes)
143
144ggplot(data=iris,
145 aes(x = Sepal.Width,
146 y = Sepal.Length,
147 colour = Species)) +
148 geom_point() +
149 theme_stata() +
150 NULL
151
152```
153
154
155# Next Steps
156
157There is still **A LOT** of work to do on this package which include (but are note limited to):
158
159- Better softcoding for front end user options in YAML
160- Images in the title section for logo placement which is a common attribut to posters as far as I have come to know.
161- Figure out compatiability with `natbib` which wasn't working during the initial set up.
162- MUCH BETTER PACKAGE DOCUMENTATION. For example, there is nothing in the README...
163- Include References section only if initiated by the user like in RMarkdown.
164
165<!--- Here you can set the size of the citation text as well as remove the "References" section if you choose not to have one for some reason :) -->
166\small\printbibliography
167
168