Brent Thorne | e153f5d | 2019-01-09 20:33:17 -0500 | [diff] [blame] | 1 | --- |
| 2 | #----ESSENTIALS----# |
| 3 | title: 'Using `posterdown` to generate reproducible conference posters via RMarkdown > Knitr > Markdown > Pandoc > Latex > PDF workflow' |
| 4 | author: "Author One^1^ Author Two^2^" |
| 5 | affiliation: "^1^Department of Poster Layouts, University of Markdown; ^2^Deparment of Another Institution, Institution University" |
| 6 | |
| 7 | #----FONT STYLE----# |
| 8 | font_size: "30pt" #sets '\normalsize' (sizes of the title and sections headings will adjust based on it) |
| 9 | font_family: "palatino" # choose from typical latex fonts (example: "palatino") |
| 10 | |
| 11 | |
| 12 | #----COLOURS----# |
| 13 | |
| 14 | #Background/ Line Colours |
| 15 | title_bgcol: "0b4545" #Hex colour for background of poster title section (default is blue) |
| 16 | poster_bgcol: "ffffff" #colour of the poster main background |
| 17 | cite_col: "CC0000" #colour of ciation elements |
| 18 | url_col: "008080" #colour of url links |
| 19 | link_col: "008080" #colour of other links within the poster |
| 20 | columnline_col: "0b4545" #colour |
| 21 | header_bgcol: "008080" |
| 22 | |
| 23 | #Text Colours |
| 24 | title_textcol: "ffffff" #colour of title text |
| 25 | author_textcol: "008080" # Colour of author text |
| 26 | affiliation_textcol: "FFFFFF" # Colour of affiliation text |
| 27 | body_textcol: "000000" # Colour of main text in the body of poster |
| 28 | header_textcol: "CC0000" # Colour of the poster header titles |
| 29 | footnote_textcol: "FFFFFF" # Colour of footnote text if used |
| 30 | |
| 31 | #----POSTER SIZE & COLUMN FORMATTING----# |
| 32 | poster_height: "38in" # height in inches of poster |
| 33 | poster_width: "45in" # width in inches of poster |
| 34 | column_numbers: 3 # Number of columns that the poster has |
| 35 | column_margins: "10mm" # Margin spacing for columns |
| 36 | |
| 37 | #----OTHER----# |
| 38 | bibliography: MyLibrary # name of the .bib file used for referencing |
| 39 | output: posterdown::posterdown_pdf |
| 40 | --- |
| 41 | |
| 42 | ```{r, include=FALSE} |
| 43 | knitr::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') |
| 44 | ``` |
| 45 | |
| 46 | <!-- |
| 47 | Bellow 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 |
| 48 | |
| 49 | ENJOY! XD |
| 50 | --> |
| 51 | |
| 52 | # Introduction |
| 53 | |
| 54 | Welcome 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. |
| 55 | |
| 56 | # Study Site |
| 57 | |
| 58 | Here 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} |
| 59 | |
| 60 | ## OTHER |
| 61 | |
| 62 | ```{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} |
| 63 | |
| 64 | plot(iris$Sepal.Length,iris$Sepal.Width, pch = 19) |
| 65 | |
| 66 | ``` |
| 67 | |
| 68 | |
| 69 | # Objectives |
| 70 | |
| 71 | \large |
| 72 | |
| 73 | 1. Easy to use reproducible poster design. |
| 74 | 2. Integration with `RMarkdown`. |
| 75 | 3. Easy transition from `posterdown` to `thesisdown` or `rticles` |
| 76 | |
| 77 | \small |
| 78 | |
| 79 | # Methods |
| 80 | |
| 81 | This package uses the same workflow approach as the `RMarkdown` you know and love. Basically it goes from RMarkdown > Knitr > Markdown > Pandoc > Latex > PDF |
| 82 | |
| 83 | # Results |
| 84 | |
| 85 | Usually 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). |
| 86 | |
| 87 | ```{r} |
| 88 | library(kableExtra) |
| 89 | library(ggplot2) |
| 90 | |
| 91 | data("iris") |
| 92 | |
| 93 | kable(iris[1:4,],align = "c", caption = "Tables are a breeze with Kable and Kable extra package!", booktabs = TRUE) %>% |
| 94 | kable_styling(latex_options = "striped",full_width = TRUE, font_size = 25) |
| 95 | |
| 96 | ``` |
| 97 | |
| 98 | \vspace{1in} |
| 99 | |
| 100 | ```{r, out.width='75%', fig.width=4, fig.height=3, fig.cap='A typical plot using ggplot using the classic iris dataset.'} |
| 101 | |
| 102 | library(ggplot2) |
| 103 | library(ggthemes) |
| 104 | |
| 105 | ggplot(data = iris, aes(x = Sepal.Length, y = Sepal.Width, colour = Species)) + |
| 106 | geom_point() + |
| 107 | theme_fivethirtyeight() + |
| 108 | labs(x = "Sepal Length", y = "Sepeal Width") + |
| 109 | NULL |
| 110 | |
| 111 | ``` |
| 112 | |
| 113 | \vspace{1in} |
| 114 | |
| 115 | ```{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.'} |
| 116 | |
| 117 | library(ggplot2) |
| 118 | library(ggthemes) |
| 119 | |
| 120 | ggplot(data = iris, aes(x = Sepal.Length, y = Sepal.Width, colour = Species)) + |
| 121 | geom_point() + |
| 122 | theme_hc() + |
| 123 | labs(x = "Sepal Length", y = "Sepeal Width") + |
| 124 | NULL |
| 125 | |
| 126 | ``` |
| 127 | |
| 128 | \vspace{1in} |
| 129 | |
| 130 | ```{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!'} |
| 131 | |
| 132 | # Here is some code for people |
| 133 | # to look at and be in awe of!!!! |
| 134 | library(ggplot2) |
| 135 | library(ggthemes) |
| 136 | |
| 137 | ggplot(data=iris, |
| 138 | aes(x = Sepal.Width, |
| 139 | y = Sepal.Length, |
| 140 | colour = Species)) + |
| 141 | geom_point() + |
| 142 | theme_stata() + |
| 143 | NULL |
| 144 | |
| 145 | ``` |
| 146 | |
| 147 | |
| 148 | # Next Steps |
| 149 | |
| 150 | There is still **A LOT** of work to do on this package which include (but are note limited to): |
| 151 | |
| 152 | - Better softcoding for front end user options in YAML |
| 153 | - Images in the title section for logo placement which is a common attribut to posters as far as I have come to know. |
| 154 | - Figure out compatiability with `natbib` which wasn't working during the initial set up. |
| 155 | - MUCH BETTER PACKAGE DOCUMENTATION. For example, there is nothing in the README... |
| 156 | - Include References section only if initiated by the user like in RMarkdown. |
| 157 | |
| 158 | <!--- 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 :) --> |
| 159 | \small\printbibliography |
| 160 | |
| 161 | |