-
Notifications
You must be signed in to change notification settings - Fork 26
/
Copy pathisMassObject-functions.Rd
50 lines (45 loc) · 1.07 KB
/
isMassObject-functions.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
\name{isMassSpectrum}
\alias{isMassSpectrum}
\alias{isMassPeaks}
\title{
Tests for MassSpectrum or MassPeaks object.
}
\description{
These functions test for a \code{\linkS4class{MassSpectrum}} or
\code{\linkS4class{MassPeaks}} object.
}
\usage{
isMassSpectrum(x)
isMassPeaks(x)
}
\arguments{
\item{x}{
object to be tested.
}
}
\value{
Returns \code{\link{TRUE}} or \code{\link{FALSE}} depending on whether its
argument is an \code{\linkS4class{MassSpectrum}} or
\code{\linkS4class{MassPeaks}} object.
}
\author{
Sebastian Gibb \email{mail@sebastiangibb.de}
}
\seealso{
\code{\linkS4class{MassPeaks}},
\code{\linkS4class{MassSpectrum}},
\code{\linkS4class{AbstractMassObject}}
Website: \url{https://strimmerlab.github.io/software/maldiquant/}
}
\examples{
## load package
library("MALDIquant")
## create a MassPeaks object
peaks <- createMassPeaks(mass=1:100, intensity=1:100,
metaData=list(name="example 1"))
## test
isMassPeaks(peaks) # returns TRUE
isMassSpectrum(peaks) # returns FALSE
isMassPeaks(double()) # returns FALSE
}
\keyword{methods}