/
word_template.Rmd
39 lines (27 loc) · 1.83 KB
/
word_template.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
---
title: "Word Template"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{Word Template}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>"
)
```
```{r setup}
library(omni)
```
# Word OMNI Template
## Creating a New Report
After you have installed the package, you will have access to a new custom RMarkdown template.
You can create a new RMarkdown document that uses the OMNI template in the same way you'd normally make a new RMarkdown document: go to File > New File > RMarkdown > OMNI Word Template.
## Executive Summary
There is an Executive Summary section. If you want to have an Executive Summary, please change the content here. Please note that the {-} at the end of the headers in that section serves an important purpose: [it makes those headers not show up in the Table of Contents](https://bookdown.org/yihui/rmarkdown/markdown-syntax.html#block-level-elements).
You'll also see some HTML above (`<div class="exec-summary">`) and below (`</div>`) the Executive Summary. This ensures all the styling works for that section. Please leave it.
## Figures, Charts, and Tables
You'll need to make sure you add titles to all figures, charts, and tables. To do so, use the `fig.cap` chunk option. You'll also need to include a special bit of code to help the template know whether the code chunk is producing a figure, chart, or table (and thus label and number it correctly). To do for a figure, for example, you'd add `out.extra='data-prefix="Figure"'` to your code chunk. You substitute "Chart" or "Table" as appropriate in other code chunks. There are examples of each in the default content of the RMarkdown template.