summary.RNAFilt: RNA Filter Summary

View source: R/filter_summary.R

summary.RNAFiltR Documentation

RNA Filter Summary

Description

Provide summary of a RNAFilt S3 object

Usage

## S3 method for class 'RNAFilt'
summary(object, size_library = NULL, min_nonzero = NULL, ...)

Arguments

object

S3 object of class 'RNAFilt' created by RNA_filter.

size_library

integer cut-off for sample library size (i.e. number of reads). Defaults to NULL.

min_nonzero

integer or float between 0 and 1. Cut-off for number of unique biomolecules with non-zero counts or as a proportion of total biomolecules. Defaults to NULL.

...

further arguments passed to or from other methods

Value

a summary table giving the minimum, maximum, 1st and 3rd quartiles, mean and standard deviation for library size (the number of unique biomolecules with non-zero observations per sample), and the proportion of non-zero observations over the total number of biomolecules.

Author(s)

Rachel Richardson

See Also

RNA_filter

Examples


library(pmartRdata)
myfilter <- RNA_filter(omicsData = rnaseq_object)
summary(myfilter)
summary(myfilter, min_nonzero = 2)


pmartR/pmartRqc documentation built on April 25, 2024, 6:18 a.m.