diff --git a/README.Rmd b/README.Rmd new file mode 100644 index 0000000..7dc431a --- /dev/null +++ b/README.Rmd @@ -0,0 +1,65 @@ +--- +output: github_document +--- + + + +# Flexdashboard poster + +Minimal template for preparing a conference poster using rmarkdown. +Check out +[`output/poster.png`](https://github.com/odeleongt/flexdashboard-poster/blob/develop/output/poster.png) +or the [html preview](https://odeleongt.github.io/flexdashboard-poster/) +for more details. + +## Dependencies + +This poster template dependes on the following R packages + +- rmarkdown [@rmarkdown] +- flexdashboard [@flexdashboard] +- webshot [@webshot] + +To use `scripts/generic-content` you will need a GNU/Linux system +and a working installation of `imagemagick`. + +## Preparing your analysis environment + +In order to use this poster template, you need to: + +1. Clone [`odeleongt/flexdashboard-poster`](https://github.com/odeleongt/flexdashboard-poster) + from github (or fork it to modify it) +1. Install the required packages: + +```{r, eval=FALSE} +install.packages("rmarkdown", "", "webshot") +``` + +1. Install the PhantomJS library + +```{r, eval=FALSE} +webshot::install_phantomjs() +``` + +1. Edit the template to fit your needs + +```{r, eval=FALSE} +file.edit("poster/flexdashboard-poster.Rmd") +``` + +1. Run `scripts/render-poster.R` + +```{r, eval=FALSE} +source("scripts/render-poster.R") +``` + +1. Take a look at your awesome new poster! + +```{r, eval=FALSE} +browseURL("output/flexdashboard-poster.html") # html version +browseURL("output/poster.png") # png version +``` + +![](output/poster.png) + + diff --git a/README.md b/README.md index 89c4941..f1850d6 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,56 @@ -# Flexdashboard poster -Minimal template for preparing a conference poster using rmarkdown. -Check out -[`output/poster.png`](https://github.com/odeleongt/flexdashboard-poster/blob/develop/output/poster.png) -or the [html preview](https://odeleongt.github.io/flexdashboard-poster/) -for more details. + +Flexdashboard poster +==================== +Minimal template for preparing a conference poster using rmarkdown. Check out [`output/poster.png`](https://github.com/odeleongt/flexdashboard-poster/blob/develop/output/poster.png) or the [html preview](https://odeleongt.github.io/flexdashboard-poster/) for more details. - -## Dependencies +Dependencies +------------ This poster template dependes on the following R packages -- rmarkdown [@rmarkdown] -- flexdashboard [@flexdashboard] -- webshot [@webshot] +- rmarkdown \[@rmarkdown\] +- flexdashboard \[@flexdashboard\] +- webshot \[@webshot\] -To use `scripts/generic-content` you will need a GNU/Linux system -and a working installation of `imagemagick`. +To use `scripts/generic-content` you will need a GNU/Linux system and a working installation of `imagemagick`. +Preparing your analysis environment +----------------------------------- +In order to use this poster template, you need to: -## Preparing your analysis environment +1. Clone [`odeleongt/flexdashboard-poster`](https://github.com/odeleongt/flexdashboard-poster) from github (or fork it to modify it) +2. Install the required packages: -In order to use this poster template, you need to: +``` r +install.packages("rmarkdown", "", "webshot") +``` + +1. Install the PhantomJS library + +``` r +webshot::install_phantomjs() +``` + +1. Edit the template to fit your needs + +``` r +file.edit("poster/flexdashboard-poster.Rmd") +``` + +1. Run `scripts/render-poster.R` + +``` r +source("scripts/render-poster.R") +``` + +1. Take a look at your awesome new poster! + +``` r +browseURL("output/flexdashboard-poster.html") # html version +browseURL("output/poster.png") # png version +``` -1. Clone [`odeleongt/flexdashboard-poster`](https://github.com/odeleongt/flexdashboard-poster) - from github -1. Install the required packages - `install.packages("rmarkdown", "flexdashboard", "webshot")` -1. Install the PhantomJS library - `webshot::install_phantomjs()` -1. Edit the template to fit your needs -1. Run `scripts/render-poster.R` +![](output/poster.png)