Browse code

Add details for acquisitionNum/precursorScanNum to documentation

jotsetung authored on 10/09/2017 16:58:02
Showing 1 changed files

... ...
@@ -129,6 +129,19 @@
129 129
   
130 130
 }
131 131
 
132
+\details{
133
+  The column \code{acquisitionNum} in the \code{data.frame} returned by
134
+  the \code{header} method contains the index during the scan in which
135
+  the signal from the spectrum was measured. The \code{pwiz} backend
136
+  extracts this number from the spectrum's ID provided in the mzML
137
+  file. In contrast, column \code{seqNum} contains the index of each
138
+  spectrum within the file and is thus consecutively numbered. Spectra
139
+  from files with multiple MS levels are linked to each other \emp{via}
140
+  their \code{acquisitionNum}: column \code{precursorScanNum} of an e.g. MS
141
+  level 2 spectrum contains the \code{acquisitionNum} of the related MS
142
+  level 1 spectrum.
143
+}
144
+
132 145
 \note{
133 146
   Spectrum identifiers are only specified in \emph{mzML} files, thus,
134 147
   for all other file types the column \code{"spectrumId"} of the result