msgfParTolerance-class: A class handling parent ion tolerance

In thomasp85/MSGFplus: An interface between R and MS-GF+

A class handling parent ion tolerance

Description

This class defines a parent ion tolerance and provides methods to get correct system call parameters.

Usage

## S4 method for signature 'msgfParTolerance'
show(object)

## S4 method for signature 'msgfParTolerance'
length(x)

## S4 method for signature 'msgfParTolerance'
getMSGFpar(object)

msgfParTolerance(value, low, high, unit)

Arguments

object	An msgfParTolerance object
x	An msgfParTolerance object
value	A numeric giving the upper and lower bounds of the tolerance
low	A numeric giving the lower bounds of the tolerance
high	A numeric giving the higher bounds of the tolerance
unit	The unit used. Either 'ppm' or 'Da'

Value

For length() An integer.

For getMSGFpar() A string.

For msgfParTolerance() An msgfParTolerance object.

Methods (by generic)

• show: Short summary of msgfParTolerance object

• length: Report the length of an msgfParTolerance object

• getMSGFpar: Get system compliant function call

Slots

unit

The unit used to define the tolerance

low

The lower bound of the tolerance

high

The higher bound of the tolerance

See Also

Other msgfParClasses: msgfPar-class, msgfParChargeRange-class, msgfParEnzyme-class, msgfParFragmentation-class, msgfParInstrument-class, msgfParIsotopeError-class, msgfParLengthRange-class, msgfParMatches-class, msgfParModification-class, msgfParModificationList-class, msgfParNtt-class, msgfParProtocol-class, msgfParTda-class, msgfPar

Examples

# Symmetric
tolerance <- msgfParTolerance(20, unit='ppm')

# Asymmetric
tolerance <- msgfParTolerance(low=0.5, high=1.5, unit='Da')

thomasp85/MSGFplus documentation built on Oct. 2, 2024, 9:26 a.m.