rnb.add.figure {RnBeads} | R Documentation

## rnb.add.figure

### Description

Generates HTML code for a figure in the specified report. A figure is a collection of images (plots), of which only one is visible at any given moment.

### Usage

    rnb.add.figure(
      report,
      description,
      report.plots,
      setting.names = list(),
      selected.image = as.integer(1)
    )

### Arguments

`report` | Report to write the text to.
`description` | Human-readable description of the figure. This must be a non-empty `character` vector. The elements of this vector are concatenated without a separator to form the full description.
`report.plots` | Object of type `ReportPlot`, or a list of such objects.
`setting.names` | List of plot file element descriptors. Every variable elements in the plot file names must be included in this list. Set this to empty list if no variable elements are present, that is, if the figure should present a single report plot.
`selected.image` | Index of plot to be initially selected in the figure.

### Value

The modified report.

### Author(s)

Yassen Assenov

### See Also

`rnb.add.tables` for adding a listing of tables; `Report` for other functions adding contents to an HTML report

[Package RnBeads version 2.12.2 Index]