blob: bd506d7f8707dad3ab3b66800a1ed82b15be590b [file] [log] [blame]
brentthorneb2fdd572019-01-04 23:32:17 -05001---
brentthorne16e18402019-01-05 10:48:08 -05002#----ESSENTIALS----#
3title: 'Using `posterdown` to generate reproducible conference posters via RMarkdown > Knitr > Markdown > Pandoc > Latex > PDF workflow'
4author: "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)
9font_family: "courier" # choose from typical latex fonts (example: "palatino")
brentthorneb2fdd572019-01-04 23:32:17 -050010
brentthorne16e18402019-01-05 10:48:08 -050011#----COLOURS----#
12title_bgcol: "000000" #Hex colour for background of poster title section (default is blue)
13poster_bgcol: "white" #colour of the poster main background
14title_textcol: "red" #colour of title text
brentthorneb2fdd572019-01-04 23:32:17 -050015header_textcol: "red" #colour of the poster header titles
brentthorne16e18402019-01-05 10:48:08 -050016cite_col: "green" #colour of ciation elements
17url_col: "cyan" #colour of url links
18link_col: "cyan" #colour of other links within the poster
19columnline_col: "blue" #colour
brentthorneb2fdd572019-01-04 23:32:17 -050020
brentthorne16e18402019-01-05 10:48:08 -050021#----POSTER SIZE & COLUMN NUMBERS----#
brentthorneb2fdd572019-01-04 23:32:17 -050022poster_height: "38in" # height in inches of poster
23poster_width: "45in" # width in inches of poster
24column_numbers: 3 # Number of columns that the poster has
25
brentthorne16e18402019-01-05 10:48:08 -050026#----OTHER----#
brentthorneb2fdd572019-01-04 23:32:17 -050027bibliography: MyLibrary # name of the .bib file used for referencing
brentthorne16e18402019-01-05 10:48:08 -050028output: posterdown::posterdown_pdf
brentthorneb2fdd572019-01-04 23:32:17 -050029---
30
31```{r, include=FALSE}
32knitr::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')
33```
34
brentthorne16e18402019-01-05 10:48:08 -050035<!--
36Bellow 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
37
38ENJOY! XD
39-->
40
brentthorneb2fdd572019-01-04 23:32:17 -050041# Introduction
42
43Welcome 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.
44
45# Study Site
46
47Here 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. \vspace{15mm}
48
brentthorne5d1588e2019-01-08 09:48:41 -050049```{r, fig.width=4.5, out.width="100%", fig.cap='Here is an example of a firgure using the iris dataset and ggplot2', cache=TRUE}
brentthorneb2fdd572019-01-04 23:32:17 -050050
brentthorne5d1588e2019-01-08 09:48:41 -050051plot(iris$Sepal.Length,iris$Sepal.Width, pch = 19)
brentthorneb2fdd572019-01-04 23:32:17 -050052
53```
54
55
56# Objectives
57
58\large
59
601. Easy to use reproducible poster design.
612. Integration with `RMarkdown`.
623. Easy transition from `posterdown` to `thesisdown` or `rticles`
63
64\small
65
66# Methods
67
68This package uses the same workflow approach as the `RMarkdown` you know and love. Basically it goes from RMarkdown > Knitr > Markdown > Pandoc > Latex > PDF
69
70# Results
71
72Usually 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).
73
74```{r}
75library(kableExtra)
76library(ggplot2)
77
78data("iris")
79
80kable(iris[1:4,],align = "c", caption = "Tables are a breeze with Kable and Kable extra package!", booktabs = TRUE) %>%
81 kable_styling(latex_options = "striped",full_width = TRUE, font_size = 25)
82
83```
84
85\vspace{1in}
86
87```{r, out.width='75%', fig.width=4, fig.height=3, fig.cap='A typical plot using ggplot using the classic iris dataset.'}
88
89library(ggplot2)
90library(ggthemes)
91
92ggplot(data = iris, aes(x = Sepal.Length, y = Sepal.Width, colour = Species)) +
93 geom_point() +
94 theme_fivethirtyeight() +
95 labs(x = "Sepal Length", y = "Sepeal Width") +
96 NULL
97
98```
99
100\vspace{1in}
101
102```{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.'}
103
104library(ggplot2)
105library(ggthemes)
106
107ggplot(data = iris, aes(x = Sepal.Length, y = Sepal.Width, colour = Species)) +
108 geom_point() +
109 theme_hc() +
110 labs(x = "Sepal Length", y = "Sepeal Width") +
111 NULL
112
113```
114
115\vspace{1in}
116
117```{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!'}
118
119# Here is some code for people
120# to look at and be in awe of!!!!
121library(ggplot2)
122library(ggthemes)
123
124ggplot(data=iris,
125 aes(x = Sepal.Width,
126 y = Sepal.Length,
127 colour = Species)) +
128 geom_point() +
129 theme_stata() +
130 NULL
131
132```
133
134
135# Next Steps
136
137There is still **A LOT** of work to do on this package which include (but are note limited to):
138
brentthorne16e18402019-01-05 10:48:08 -0500139- Better softcoding for front end user options in YAML
brentthorneb2fdd572019-01-04 23:32:17 -0500140- Images in the title section for logo placement which is a common attribut to posters as far as I have come to know.
141- Figure out compatiability with `natbib` which wasn't working during the initial set up.
142- MUCH BETTER PACKAGE DOCUMENTATION. For example, there is nothing in the README...
143- Include References section only if initiated by the user like in RMarkdown.
144
brentthorne16e18402019-01-05 10:48:08 -0500145<!--- Here you can set the size of the citation text -->
brentthorneb2fdd572019-01-04 23:32:17 -0500146\small