addFooter.bsdoc

0th

Percentile

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 set_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

bsdoc

Aliases
  • addFooter.bsdoc
Examples
# NOT RUN {
#START_TAG_TEST

# Create a new document
doc = bsdoc( title = "title" )

doc = addFooter( doc,
  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") ),
  parCenter( padding = 2 )
)

# write the html object in a directory
writeDoc( doc, "addFooter/example.html")
#STOP_TAG_TEST
# }
Documentation reproduced from package ReporteRs, version 0.6.9, License: GPL-3

Community examples

Looks like there are no examples yet.