plotAlevinHistogram: Histogram of selected summary statistic

View source: R/plotAlevinHistogram.R

plotAlevinHistogramR Documentation

Histogram of selected summary statistic

Description

Histogram of selected summary statistic

Usage

plotAlevinHistogram(
  cbTable,
  plotVar = "dedupRate",
  axisLabel = plotVar,
  colName = "inFinalWhiteList",
  cbName = "final whitelist",
  firstSelColName = "inFirstWhiteList"
)

Arguments

cbTable

data.frame (such as the cbTable returned by readAlevinQC or readAlevinFryQC) containing the desired summary statistic in a column.

plotVar

Character scalar giving the name of a numeric column of cbTable to plot.

axisLabel

Character scalar giving the label of the selected statistic (will be displayed as the axis label in the plot).

colName

Character scalar giving the name of a logical column of cbTable to use for filling the bars in the histogram.

cbName

Character scalar giving the name of the set of barcodes defined by colName, used for labelling the plot legend.

firstSelColName

Character scalar indicating the name of the logical column in cbTable that corresponds to the original selection of barcodes for quantification.

Value

A ggplot object

Author(s)

Charlotte Soneson

Examples

alevin <- readAlevinQC(system.file("extdata/alevin_example_v0.14",
                                   package = "alevinQC"))
plotAlevinHistogram(alevin$cbTable, plotVar = "dedupRate",
                    axisLabel = "Deduplication rate",
                    colName = "inFinalWhiteList",
                    cbName = "final whitelist")


csoneson/alevinQC documentation built on Dec. 16, 2024, 6:14 p.m.