Knitr & Rmarkdown docx tables

Question

When using knitr and rmarkdown together to create a word document you can use an existing document to style the output.

For example in my yaml header:

output:    word_document:     reference_docx: style.docx     fig_caption: TRUE 

within this style i have created a default table style - the goal here is to have the kable table output in the correct style.

When I knit the word document and use the style.docx the tables are not stylized according to the table.

Using the style inspector has not been helpful so far, unsure if the default table style is the incorrect style to modify.

Example Code:

```{r kable} n <- 100 x <- rnorm(n) y <- 2*x + rnorm(n) out <- lm(y ~ x) library(knitr) kable(summary(out)$coef, digits=2, caption = "Test Captions") ``` 

I do not have a stylized document I can upload for testing unfortunately.

TL;DR: Want to stylise table output from rmarkdown and knitr automatically (via kable)

Update: So far I have found that changing the 'compact' style in the docx will alter the text contents of the table automatically - but this does not address the overall table styling such as cell colour and alignment.

Update 2: After more research and creation of styles I found that knitr seems to have no problem accessing paragraph styles. However table styles are not under that style category and don't seem to apply in my personal testing.

Update 3: Dabbled with the ReporteRs package - whilst it was able to produce the tables as a desired the syntax required to do so is laborious. Much rather the style be automatically applied.

Update 4: You cannot change TableNormal style, nor does setting a Table Normal style work. The XML approach is not what we are looking for. I have a VBA macro that will do the trick, just want to remove that process if possible.

Answer 1

This is essentially a combination of the answer that recommends TableNormal, this post on rmarkdown.rstudio.com and my own experiments to show how to use a TableNormal style to customize tables like those generated by kable:

RMD:

--- output:   word_document ---  ```{r} knitr::kable(cars) ``` 

• Click "Knit Word" in RStudio. → The document opens in Word, without any custom styles yet.
• In that document (not in a new document), add the required styles. This article explains the basics. Key is not to apply direct styles but to modify the styles. See this article on support.office.com on Style basics in Word.
• Specifically, to style a table you need to add a table style. My version of Word is non-English, but according to the article linked above table styles are available via "the Design tab, on the Table Tools contextual tab".
• Choose TableNormal as style name and define the desired styles. In my experiments most styles worked, however some did not. (Adding a color to the first column and making the first row bold was no problem; highlighting every second row was ignored.) The last screenshot in this answer illustrates this step.
• Save the document, e.g. as styles.docx.

• Modify the header in the RMD file to use the reference DOCX (see here; don't screw up the indentation – took me 10 minutes find this mistake):

  --- output:   word_document:     reference_docx: styles.docx --- 

• Knit to DOCX again – the style should now be applied.

Following the steps I described above yields this output:

And here a screenshot of the table style dialog used to define TableNormal. Unfortunately it is in German, but maybe someone can provide an English version of it:

---

As this does not seem to work for most users (anyone but me …), I suggest we test this systematically. Essentially, there are 4 steps that can go wrong:

• Wrong RMD (unlikely).
• Differences in the initially generated DOCX.
• Differences in how the TableNormal style is saved in the DOCX.
• Differences in how the reference DOCX is used to format the final DOCX.

I therefore suggest using the same minimal RMD posted above (full code on pastebin) to find out where the results start do differ:

• My initially generated DOCX.
• The same document with TableNormal added: reference.docx
• The final document.

The three files are generated on the following system: Windows 7 / R 3.3.0 / RStudio 0.99.896 / pandoc 1.15.2 / Office 2010.

I get the same results on a system with Windows 7 / R 3.2.4 / RStudio 0.99.484 / pandoc 1.13.1 / Office 2010.

I suppose the most likely culprits are the pandoc and the Office versions. Unfortunately, I cannot test other configurations at the moment. Now it would be interesting to see the following: For users where it does not work, what happens …

• … if you start from my initial.docx?
• If that does not work, what if you use my reference.docx as reference document?
• If nothing works, are there eye-catching differences in the generated XML files (inside the DOCX container)? Please share your files and exact version information.

With a number of users running these tests it should be possible to find out what is causing the problems.