addTOC-methods: Insert a table of contents into the docx document

In davidgohel/R2DOCX: Create MS docx documents from R

Description

Insert a table of contents into the Docx object.

Usage

  ## S4 method for signature 'Docx,character'
addTOC(x, stylename)

Arguments

x	the Docx to use
stylename	name of the style used to construct the TOC

Details

This function add a table of contents in a doc object.
It can also add custom table of contents, for example a table of content for the added plots.

• stylename : Stylename in the document that will be used to build entries of the TOC (a character vector of length 1).
  

Examples

# example 1
doc <- new("Docx", title = "My example" )
doc <- addTOC(doc)
# add headers and content here
writeDoc( doc, "toc_example.docx" )




# example 2
require(ggplot2)
doc <- new("Docx", title = "My example" )
# Because we will use "PlotReference" as legend in plot 
# later, addTOC will use this stylename to define 
# entries in the generated TOC 
doc <- addTOC(doc, stylename = "PlotReference")

doc = addPlot( doc
		, fun = plot
		, x = rnorm( 100 )
		, y = rnorm (100 )
		, main = "base plot main title"
		, legend="graph example 1", stylename = "PlotReference"
	)

doc = addTable( doc, iris )
doc = addParagraph( doc, value="table 1", stylename = "PlotReference" )

doc = addPlot( doc
		, fun = plot
		, x = rnorm( 100 )
		, y = rnorm (100 )
		, main = "base plot main title"
		, legend="graph example 2", stylename = "PlotReference"
	)


writeDoc( doc, "toc_example.docx" )

davidgohel/R2DOCX documentation built on May 14, 2019, 11:13 p.m.