summary.massFilt: Summary method for massFilt object
In EMSL-Computing/fticRanalysis: Analysis and visualization tools for FT-MS data
View source: R/filter_summary_methods.R
summary.massFilt R Documentation
Summary method for massFilt object
Description
Summary method for massFilt object
Usage
## S3 method for class 'massFilt'
summary(object, min_mass = NULL, max_mass = NULL, ...)
Arguments
object
an object of class 'massFilt' created by running mass_filter
min_mass
an integer value specifying the minimum mass a peak must have to be retained in the dataset (inclusive). If only max_mass is provided, then this values is assumed to be the minimum observed mass value.
max_mass
an integer value specifying the maximum mass a peak can have to be retained in the dataset (inclusive). If only min_mass is provided, then this value is assumed to be the maximum observed mass value.
...
included for compliance with generic method
Value
If min_mass and/or max_mass is provided, a summary of the effect of implementing a filter with the specified thresholds. Otherwise, a five-number summary and the mean value of the mass values observed across all samples are given.
EMSL-Computing/fticRanalysis documentation built on Dec. 18, 2024, 9:51 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/filter_summary_methods.R
| summary.massFilt | R Documentation |
Summary method for massFilt object
Description
Summary method for massFilt object
Usage
## S3 method for class 'massFilt'
summary(object, min_mass = NULL, max_mass = NULL, ...)
Arguments
object |
an object of class 'massFilt' created by running |
min_mass |
an integer value specifying the minimum mass a peak must have to be retained in the dataset (inclusive). If only |
max_mass |
an integer value specifying the maximum mass a peak can have to be retained in the dataset (inclusive). If only |
... |
included for compliance with generic method |
Value
If min_mass and/or max_mass is provided, a summary of the effect of implementing a filter with the specified thresholds. Otherwise, a five-number summary and the mean value of the mass values observed across all samples are given.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.