blob: 91ffe996be0f7afa29afe4f1ab67668a604aa747 [file] [log] [blame]
brentthorneb2fdd572019-01-04 23:32:17 -05001---
brentthorne16e18402019-01-05 10:48:08 -05002#----ESSENTIALS----#
brentthornec7c1c5a2019-01-10 01:54:11 -05003title: '\fontfamily{phv}\selectfont Using posterdown to generate reproducible conference posters via RMarkdown > Knitr > Markdown > Pandoc > Latex > PDF workflow'
brentthorne16e18402019-01-05 10:48:08 -05004author: "Author One^1^ Author Two^2^"
brentthorne2d2faee2019-01-07 11:42:21 -05005affiliation: "^1^Department of Poster Layouts, University of Markdown; ^2^Deparment of Another Institution, Institution University"
brentthorneb2fdd572019-01-04 23:32:17 -05006
brentthorne16e18402019-01-05 10:48:08 -05007#----FONT STYLE----#
8font_size: "30pt" #sets '\normalsize' (sizes of the title and sections headings will adjust based on it)
brentthornec7c1c5a2019-01-10 01:54:11 -05009font_family: "palatino" # choose from typical latex fonts (example: "palatino")
brentthorneb2fdd572019-01-04 23:32:17 -050010
brentthorne16e18402019-01-05 10:48:08 -050011#----COLOURS----#
brentthorneb2fdd572019-01-04 23:32:17 -050012
brentthorne342f0e42019-01-08 14:56:27 -050013#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----#
brentthorneb2fdd572019-01-04 23:32:17 -050031poster_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
brentthorne342f0e42019-01-08 14:56:27 -050034column_margins: "10mm" # Margin spacing for columns
brentthorneb2fdd572019-01-04 23:32:17 -050035
brentthorne16e18402019-01-05 10:48:08 -050036#----OTHER----#
brentthorneb2fdd572019-01-04 23:32:17 -050037bibliography: MyLibrary # name of the .bib file used for referencing
brentthorne16e18402019-01-05 10:48:08 -050038output: posterdown::posterdown_pdf
brentthorne507f2732019-01-15 22:17:15 -050039header-includes:
40- \usepackage[breakable]{tcolorbox}
41
brentthorneb2fdd572019-01-04 23:32:17 -050042---
43
44```{r, include=FALSE}
45knitr::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')
46```
47
brentthorne16e18402019-01-05 10:48:08 -050048<!--
49Bellow 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
50
51ENJOY! XD
52-->
53
brentthorneb2fdd572019-01-04 23:32:17 -050054# Introduction
55
56Welcome 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.
57
58# Study Site
59
brentthorne55ed6782019-01-10 11:36:59 -050060Here 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.
brentthorneb2fdd572019-01-04 23:32:17 -050061
brentthorne55ed6782019-01-10 11:36:59 -050062```{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}
63library(ggplot2)
64library(ggspatial)
65library(ggthemes)
66library(sf)
brentthornec7c1c5a2019-01-10 01:54:11 -050067
brentthorne55ed6782019-01-10 11:36:59 -050068canada <- read_sf("data/Canada.geojson")
brentthorneb2fdd572019-01-04 23:32:17 -050069
brentthorne55ed6782019-01-10 11:36:59 -050070ggplot() +
71 ggspatial::layer_spatial(canada, fill = "grey") +
72 ggspatial::annotation_north_arrow(location = "br", which_north = "true", style = north_arrow_nautical()) +
73 coord_sf() +
74 theme_solarized() +
75 NULL
brentthorneb2fdd572019-01-04 23:32:17 -050076```
77
78
79# Objectives
80
81\large
82
831. Easy to use reproducible poster design.
842. Integration with `RMarkdown`.
853. Easy transition from `posterdown` to `thesisdown` or `rticles`
86
87\small
88
89# Methods
90
91This package uses the same workflow approach as the `RMarkdown` you know and love. Basically it goes from RMarkdown > Knitr > Markdown > Pandoc > Latex > PDF
92
93# Results
94
95Usually 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).
96
97```{r}
98library(kableExtra)
99library(ggplot2)
100
101data("iris")
102
103kable(iris[1:4,],align = "c", caption = "Tables are a breeze with Kable and Kable extra package!", booktabs = TRUE) %>%
104 kable_styling(latex_options = "striped",full_width = TRUE, font_size = 25)
105
106```
107
108\vspace{1in}
109
110```{r, out.width='75%', fig.width=4, fig.height=3, fig.cap='A typical plot using ggplot using the classic iris dataset.'}
111
112library(ggplot2)
113library(ggthemes)
114
115ggplot(data = iris, aes(x = Sepal.Length, y = Sepal.Width, colour = Species)) +
116 geom_point() +
117 theme_fivethirtyeight() +
118 labs(x = "Sepal Length", y = "Sepeal Width") +
119 NULL
120
121```
122
123\vspace{1in}
124
125```{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.'}
126
127library(ggplot2)
128library(ggthemes)
129
130ggplot(data = iris, aes(x = Sepal.Length, y = Sepal.Width, colour = Species)) +
131 geom_point() +
132 theme_hc() +
133 labs(x = "Sepal Length", y = "Sepeal Width") +
134 NULL
135
136```
137
138\vspace{1in}
139
140```{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!'}
141
142# Here is some code for people
143# to look at and be in awe of!!!!
144library(ggplot2)
145library(ggthemes)
146
147ggplot(data=iris,
148 aes(x = Sepal.Width,
149 y = Sepal.Length,
150 colour = Species)) +
151 geom_point() +
152 theme_stata() +
153 NULL
154
155```
156
157
158# Next Steps
159
160There is still **A LOT** of work to do on this package which include (but are note limited to):
161
brentthorne16e18402019-01-05 10:48:08 -0500162- Better softcoding for front end user options in YAML
brentthorneb2fdd572019-01-04 23:32:17 -0500163- Images in the title section for logo placement which is a common attribut to posters as far as I have come to know.
164- Figure out compatiability with `natbib` which wasn't working during the initial set up.
165- MUCH BETTER PACKAGE DOCUMENTATION. For example, there is nothing in the README...
166- Include References section only if initiated by the user like in RMarkdown.
167
brentthornec7c1c5a2019-01-10 01:54:11 -0500168<!--- 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 :) -->
169\small\printbibliography
170
171