Browse code

Update documentation

jotsetung authored on 06/09/2017 13:52:46
Showing 1 changed files

... ...
@@ -90,14 +90,15 @@
90 90
   will return a numeric of length \code{n}.
91 91
   
92 92
   The \code{\link{header}} function returns a list containing
93
-  \code{seqNum}, \code{acquisitionNum} , \code{msLevel},
93
+  \code{seqNum}, \code{acquisitionNum}, \code{msLevel},
94 94
   \code{peaksCount}, \code{totIonCurrent}, \code{retentionTime} (in
95 95
   seconds), \code{basePeakMZ}, \code{basePeakIntensity},
96 96
   \code{collisionEnergy}, \code{ionisationEnergy}, \code{lowM},
97 97
   \code{highMZ}, \code{precursorScanNum}, \code{precursorMZ},
98 98
   \code{precursorCharge}, \code{precursorIntensity},
99 99
   \code{mergedScan}, \code{mergedResultScanNum},
100
-  \code{mergedResultStartScanNum} and \code{mergedResultEndScanNum},
100
+  \code{mergedResultStartScanNum}, \code{mergedResultEndScanNum},
101
+  \code{spectrumId} and
101 102
   \code{injectionTime} (ion injection time, in seconds) when available
102 103
   in the original file. If multiple scans are queried, a
103 104
   \code{data.frame} is returned with the scans reported along the
... ...
@@ -128,6 +129,16 @@
128 129
   
129 130
 }
130 131
 
132
+\note{
133
+  Spectrum identifiers are only specified in \emph{mzML} files, thus,
134
+  for all other file types the column \code{"spectrumId"} of the result
135
+  \code{data.frame} returned by \code{header} contains \code{"scan="}
136
+  followed by the acquisition number of the spectrum. Also, only the
137
+  \code{pwiz} backend supports extraction of the spectras' IDs from
138
+  \emph{mzML} files. Thus, only \emph{mzML} files read with
139
+  \code{backend = "pwiz"} provide the spectrum IDs defined in the file.
140
+}
141
+
131 142
 \seealso{
132 143
   \code{\link{instrumentInfo}} for metadata access and the
133 144
   \code{"\linkS4class{mzR}"} class.