Read Overall Statistics from CellBender

Get data.frame with all metrics from the CellBender remove-background analysis.

Read_Metrics_CellBender(base_path, lib_list = NULL, lib_names = NULL)

Arguments

base_path

path to the parent directory which contains all of the sub-directories of interest or path to single metrics csv file.

lib_list

a list of sample names (matching directory names) to import. If NULL will read in all samples in parent directory.

lib_names

a set of sample names to use for each sample. If NULL will set names to the directory name of each sample.

Value

A data frame with sample metrics from CellBender.

Examples

if (FALSE) {
CB_metrics <- Read_Metrics_CellBender(base_path = "/path/to/directories")
}