summary.totalCountFilt: Total Count Filter Summary

View source: R/filter_summary.R

summary.totalCountFiltR Documentation

Total Count Filter Summary

Description

Provide summary of a totalCountFilt S3 object

Usage

## S3 method for class 'totalCountFilt'
summary(object, min_count = NULL, ...)

Arguments

object

S3 object of class 'totalCountFilt' created by total_count_filter.

min_count

numeric value greater than 1 and less than the value given by filter_object$Total_Count. Values below min_count are filtered out. Default value is NULL.

...

further arguments passed to or from other methods

Value

a summary of the Total Count values, number of zero values, and non-zero values. If a min_count is provided the biomolecules that would be filtered at this threshold are reported.

Author(s)

Rachel Richardson

See Also

total_count_filter

Examples



library(pmartRdata)
myfilt <- total_count_filter(omicsData = rnaseq_object)
summary(myfilt, min_count = 15)



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