readAlevinQC {alevinQC} | R Documentation

## Read alevin data required to generate summary report

### Description

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

### Usage

    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

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

[Package alevinQC version 1.6.1 Index]