summary.emetaFilt: Summary method for emetaFilt object

In EMSL-Computing/fticRanalysis: Analysis and visualization tools for FT-MS data

Summary method for emetaFilt object

Description

Summary method for emetaFilt object

Usage

## S3 method for class 'emetaFilt'
summary(object, min_val = NULL, max_val = NULL, cats = NULL, na.rm = TRUE, ...)

Arguments

object	an object of class 'emetaFilt' created by running emeta_filter
min_val	used only if filter variable specified was quantitative. Minimum value which the filter variable can take (inclusive) to remain in the data
max_val	used only if filter variable specified was quantitative. Maximum value which the filter variable can take (inclusive) to remain in the data
cats	used only if filter variable specified was categorical. Levels of categorical variable which should be retained in the data
na.rm	should peaks with an NA value for the filter variable be removed. Defaults to TRUE.
...	included for compliance with generic method

Value

If relevant parameter(s) are provided, a summary of the effect of implementing a filter. Otherwise, a five number summary and the mean value for the filter variable (quantitative) or a summary of the number of peaks per category (categorical).

EMSL-Computing/fticRanalysis documentation built on Dec. 18, 2024, 9:51 p.m.