Generate alevin/alevin-fry summary shiny app

Generate a shiny app summarizing the main aspects of an alevin/alevin-fry quantification run. The app generation assumes that alevin has been run with the –dumpFeatures flag to generate the necessary output files.

alevinQCShiny(baseDir, sampleId, customCBList = list(), addStopButton = TRUE)

alevinFryQCShiny(mapDir, permitDir, quantDir, sampleId, addStopButton = TRUE)

simpleafQCShiny(simpleafQuantDir, sampleId, addStopButton = TRUE)

Arguments

baseDir

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

sampleId

Sample ID, will be used set the title for the app.

customCBList

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

addStopButton

Logical scalar. If TRUE (default), will add a dropdown menu with a button to stop the app (by calling shiny::stopApp) and return a list with the information displayed in the app.

mapDir

(Only used for alevin-fry output) Path to the output directory from the salmon alevin run (should be the directory containing the map.rad file).

permitDir

(Only used for alevin-fry output) Path to the output directory from the permit list generation step (should be the directory containing the all_freq.tsv file).

quantDir

(Only used for alevin-fry output) Path to the output directory from the alevin-fry quantification step (should be the directory containing the alevin directory).

simpleafQuantDir

(Only used for simpleaf output) Path to the output directory from the simpleaf run (should be the directory containing the af_map and af_quant directories).

Value

A shiny app.

Author

Charlotte Soneson

Examples

app <- alevinQCShiny(
    baseDir = system.file("extdata/alevin_example_v0.14",
                          package = "alevinQC"),
    sampleId = "example")
if (interactive()) {
    shiny::runApp(app)
}

app <- alevinFryQCShiny(
    mapDir = system.file("extdata/alevinfry_example_v0.5.0/map",
                         package = "alevinQC"),
    permitDir = system.file("extdata/alevinfry_example_v0.5.0/permit",
                            package = "alevinQC"),
    quantDir = system.file("extdata/alevinfry_example_v0.5.0/quant",
                           package = "alevinQC"),
    sampleId = "example")
if (interactive()) {
    shiny::runApp(app)
}

app <- simpleafQCShiny(
    simpleafQuantDir = system.file("extdata/alevinfry_example_piscem_v0.6.0",
                                   package = "alevinQC"),
    sampleId = "example")
if (interactive()) {
    shiny::runApp(app)
}