addTOC
From ReporteRs v0.8.10
by David Gohel
Add a table of contents into a document object
Add a table of contents into a document object
Usage
addTOC(doc, ...)# S3 method for docx
addTOC(doc, stylename, level_max = 3, ...)
Arguments
- doc
document object
- ...
further arguments passed to other methods
- stylename
optional. Stylename in the document that will be used to build entries of the TOC.
- level_max
max title level to show in the TOC (defaut to 3, from title1 to title3).
Details
When working with docx
object:
If stylename is not used, a classical table of content will be produced.
If stylename is used, a custom table of contents will be produced,
pointing to entries that have been formated with stylename
.
For example, this can be used to produce a toc with only plots.
Value
a document object
See Also
Examples
# NOT RUN {
# simple TOC -----
# Create a new document
doc = docx( title = "title" )
#leave the first page blank and add a page break
doc = addPageBreak(doc)
# add a TOC (to be refresh when document is opened)
# and add a page break
doc = addTOC(doc)
doc = addPageBreak(doc)
# add titles that will be entries in the TOC
doc = addTitle( doc, "My first title", level = 1 )
doc = addTitle( doc, "My second title", level = 1 )
# Write the object in file "addTOC_example1.docx"
writeDoc( doc, "addTOC_example1.docx" )
# custom TOC -----
doc = docx( title = "title" )
#leave the first page blank and add a page break
doc = addPageBreak(doc)
doc = addTitle( doc, "Plots", level = 1 )
doc = addPlot( doc, fun = plot,
x = rnorm( 100 ),y = rnorm (100 ),
main = "base plot main title"
)
doc = addParagraph( doc, value="graph example 1", stylename = "rPlotLegend" )
if( requireNamespace("ggplot2", quietly = TRUE) ){
myplot = ggplot2::qplot(Sepal.Length, Petal.Length,
data = iris, color = Species,
size = Petal.Width, alpha = I(0.7))
doc = addPlot( doc = doc, fun = print,
x = myplot #this argument MUST be named, print is expecting argument 'x'
)
doc = addParagraph( doc, value="graph example 2",
stylename = "rPlotLegend" )
}
# Because we used "rPlotLegend" as legend in plot
# , addTOC will use this stylename to define
# entries in the generated TOC
doc = addTOC(doc, stylename = "rPlotLegend")
# Write the object in file "addTOC_example2.docx"
writeDoc( doc, "addTOC_example2.docx" )
# }
Community examples
Looks like there are no examples yet.