R Markdown Template for Business Reports
Want to share your content on R-bloggers? click here if you have a blog, or here if you don't.
In this post I’d like to introduce the R Markdown template for business reports by INWTlab. It’s been my aim to have a nice and clean template that is easy to customize in colors, cover and logo. I know there are quite a few templates available, but I was missing one to be used in a corporate environment. That is, I want to have a logo included and a cover page that also can be styled in a corporate design. In many companies nowadays MS Word is still THE reporting tool, so the overall look and feel is loosly oriented at MS Word defaults. In addition, this template can be extended by hacking the tex file defs.tex. In my eyes a tex file is way easier to hack – especially for not so experienced latex users – than style files (.sty).
Installation
You can install the package from the INWTlab Github Repository ireports. If you haven’t installed devtools yet, please do that first.
<code><pre class="r"># install.packages("devtools") devtools::install_github("INWTlab/ireports") Once the package is installed, you can already use the template in its default version by selecting R Markdown… > From Template > INWTlab Business Report and then clicking OK. As result a new Rmd script pops up and you can knit it right away. This is what the default report looks like:
Usage
Text & Graphics
You can write text and add graphics just like you would in any other R Markdown document.
Tables
In order to generate tables in MS Word style you can use the example code snippet below. It renders a table from the iris data set.
<code><pre class="r">tab <- xtable(head(iris, n = 20), align = "|C|C|C|C|C|C|") addtorow <- list() addtorow$pos <- list() addtorow$pos[[1]] <- -1 addtorow$command <- c("\\rowcolor{colorTwo}") print(tab, include.rownames = FALSE, tabular.environment = "tabularx", width = "\\textwidth", comment = FALSE, add.to.row = addtorow) This code snippet consists of three parts:
- The table creation. With xtable() I create an object tab of class xtable. Make sure to edit the align option as the number of columns changes.
- The coloring of the header row. I color the header via a latex code snippet which is placed in the header of the latex table code. The add.to.row option in print() enables me to put a code snippet into the latex code wherever I like by specifying a command and a position in a separate list, here called addtorow.
- The table printing itself.
So, when you create a new table, all you have to do is to create the xtable object tab in the first row, making sure that the align has the right number of columns specified.
Customization
Logo and Cover
When you create a new R Markdown file from the template, RStudio creates a new folder in your working directory (check with getwd()). You can overwrite logo.png and cover.png in this folder with your own files. Keep in mind to either name your files exactly like mine or to correct the file names in the yaml header. The recommended dimension for the logo is 350 x 130 pixels. The cover should have 1654 x 2339 pixels. In the case you want to use other dimensions, you need to hack the tex file defs.tex in order to make it look nice.
Colors
There are currently two colors in use, namely iblue and igray. If you’d like to adopt your corporate colors, change the hexadecimal color values for iblue and igray in the yaml header.
Collaboration
You’re welcome to help improve this template, just open an issue on GitHub or send a pull request.
R-bloggers.com offers daily e-mail updates about R news and tutorials about learning R and many other topics. Click here if you're looking to post or find an R/data-science job.
Want to share your content on R-bloggers? click here if you have a blog, or here if you don't.