readAlevinQC: Read alevin data required to generate summary report

Description Usage Arguments Value Author(s) Examples

View source: R/readAlevinQC.R

Description

Read all alevin output files required to generate the summary report or shiny app.

Usage

1
readAlevinQC(baseDir, customCBList = list())

Arguments

baseDir

Path to the output directory from the alevin run (should be the directory containing the alevin directory).

customCBList

Named list with custom set(s) of barcodes to provide summary statistics/plots for, in addition to the whitelists generated by alevin.

Value

A list collecting all necessary information for generating the summary report/shiny app.

Author(s)

Charlotte Soneson

Examples

1
2
alevin <- readAlevinQC(system.file("extdata/alevin_example_v0.14",
                       package = "alevinQC"))

alevinQC documentation built on Feb. 4, 2021, 2:01 a.m.