addFooter.bsdoc
From ReporteRs v0.8.2
by David Gohel
Add text in footer of a bsdoc
object
Add text in footer of a bsdoc
object. The function has
the same behaviour than addParagraph, except that its content will be
written in the footer part of the bsdoc
instead of the body of
the document.
Usage
# S3 method for bsdoc
addFooter(doc, value, par.properties = parProperties(),
restart.numbering = FALSE, ...)
Arguments
- doc
bsdoc
object- value
text to add to in the footer as paragraphs: an object of class
pot
or an object of classset_of_paragraphs
or a character vector.- par.properties
parProperties
to apply to paragraphs.- restart.numbering
boolean value. If
TRUE
, next numbered list counter will be set to 1.- ...
further arguments, not used.
Value
a bsdoc
object
See Also
Examples
# NOT RUN {
#START_TAG_TEST
doc.filename = "addFooter/example.html"
# set default font size to 11
options( "ReporteRs-fontsize" = 11 )
doc = bsdoc( )
doc = addFooter( doc, value = pot( "Code licensed under ",
format = textProperties(color="gray") ) +
pot("GPL-3", format = textProperties(color="#428bca"),
hyperlink = "https://gnu.org/licenses/gpl.html" ) +
pot(".", format = textProperties(color="gray") ),
par.properties = parCenter( padding = 2 )
)
# Write the object
writeDoc( doc, file = doc.filename )
#STOP_TAG_TEST
# }
Community examples
Looks like there are no examples yet.