R: Plot legend

makePlot.legend.box {QoRTs}

R Documentation

Plot legend

Description

Plots the universal legend for a given plotter object.

Usage

makePlot.legend.box(plotter, debugMode, singleEndMode, 
                    cex.legend, ncol, 
                    plot = TRUE, 
                    ...)
makePlot.legend.over(position, 
                 plotter, 
                 debugMode ,
                 singleEndMode, 
                 ncol = NULL,
                 plot = TRUE, 
                 ...)

Arguments

`plotter`	A `QoRT_Plotter` reference object. See `build.plotter`.
`position`	For makePlot.legend.over, a character string indicating the location where you want the legend to appear. This is passed to `legend`, and can be any keyword allowed by `xy.coords`. For example: "top", "topleft","bottomright", etc.
`debugMode`	Logical. If TRUE, debugging data will be printed to the console.
`singleEndMode`	Logical. Determines whether the dataset consists of single-ended reads. By default this is determined from the data. Thus, this parameter should never need to be set by the user.
`cex.legend`	Numeric. The cex expansion factor passed to `legend`. By default the cex is autofitted to fill the available space.
`ncol`	Integer value. The number of columns in the legend. By default this will be selected automatically depending on the number of items in the legend.
`plot`	Logical. If FALSE, suppress plotting and return `TRUE` if and only if the data is present in the dataset to allow plotting. Useful to automatically filter out missing data plots.
`...`	Arguments to be passed to methods, such as graphical parameters (see `par`).

Details

makePlot.legend.box creates a new plot (opening the next graphics frame), and writes a small description of the given plotter type along with plotting a color-coded legend (if applicable).

makePlot.legend.over adds a legend to the current plotting frame.

Examples

data(res,package="QoRTsExampleData");
plotter <- build.plotter.colorByGroup(res);
#Add a legend to an existing plot:
makePlot.strandedness.test(plotter);

## Starting: Strandedness Test plot.

## Finished: Strandedness Test plot.[time: 2018-09-25 13:12:41],[elapsed: 0.07 secs]

makePlot.legend.over("topright", plotter)

plot of chunk unnamed-chunk-1

#Or make a legend as a separate plot:
makePlot.legend.box(plotter);