Format for converting from R Markdown to an MS Word document.
word_document(
toc = FALSE,
toc_depth = 3,
number_sections = FALSE,
fig_width = 5,
fig_height = 4,
fig_caption = TRUE,
df_print = "default",
highlight = "default",
reference_docx = "default",
keep_md = FALSE,
md_extensions = NULL,
pandoc_args = NULL
)
TRUE
to include a table of contents in the output
Depth of headers to include in table of contents
TRUE
to number section headings
Default width (in inches) for figures
Default height (in inches) for figures
TRUE
to render figures with captions
Method to be used for printing data frames. Valid values
include "default", "kable", "tibble", and "paged". The "default" method
uses a corresponding S3 method of print
, typically
print.data.frame
. The "kable" method uses the
knitr::kable
function. The "tibble" method uses
the tibble package to print a summary of the data frame. The "paged"
method creates a paginated HTML table (note that this method is only valid
for formats that produce HTML). In addition to the named methods you can
also pass an arbitrary function to be used for printing data frames. You
can disable the df_print
behavior entirely by setting the option
rmarkdown.df_print
to FALSE
. See
Data
frame printing section in bookdown book for examples.
Syntax highlighting style passed to Pandoc.
Supported built-in styles include "default", "tango", "pygments", "kate", "monochrome", "espresso", "zenburn", "haddock", and "breezedark".
Two custom styles are also included, "arrow", an accessible color scheme, and "rstudio", which mimics the default IDE theme. Alternatively, supply a path to a .theme file to use a custom Pandoc style. Note that custom theme requires Pandoc 2.0+.
Pass NULL
to prevent syntax highlighting.
Use the specified file as a style reference in producing a docx file. For best results, the reference docx should be a modified version of a docx file produced using pandoc. Pass "default" to use the rmarkdown default styles.
Keep the markdown file generated by knitting.
Markdown extensions to be added or removed from the
default definition of R Markdown. See the rmarkdown_format
for
additional details.
Additional command line options to pass to pandoc
R Markdown output format to pass to render
See the online
documentation for additional details on using the word_document
format.
R Markdown documents can have optional metadata that is used to generate a document header that includes the title, author, and date. For more details see the documentation on R Markdown metadata.
R Markdown documents also support citations. You can find more information on the markdown syntax for citations in the Bibliographies and Citations article in the online documentation.