RnBeads (version 1.4.0)

rnb.add.section: rnb.add.section

Description

Generates HTML code for a new section in the specified report.

Usage

rnb.add.section(report, title, description, level = 1L, collapsed = FALSE)

Arguments

report

Report to write the text to.

title

Section header. This must be a single-element character vector.

description

Human-readable paragraph text of the section in the form of a character vector. Elements of this vector are concatenated without a separator to form the full description. Set this to NULL if the section does not (yet) contain text.

level

Section level as a single integer. It must be one of 1, 2 or 3, denoting section, subsection and sub-subsection, respectively.

collapsed

Flag indicating if the contents of this section is to be initially collapsed. Possible values are TRUE (the section is not visible), FALSE (default, the section is expanded) and "never" (the section cannot be collapsed or expanded).

Value

The modified report.

See Also

Report for other functions adding contents to an HTML report

Examples

report <- createReport("example.html", "Example", init.configuration = TRUE)
report <- rnb.add.section(report, "Introduction", "This is how it's done.")