Add note explaining precursorScanNum being set to 0

lgatto · Oct 17, 2017 · c043544 · c043544
1 parent 434ac16
commit c043544
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/R/methods-write.R b/R/methods-write.R
@@ -25,10 +25,10 @@
 #'     m/z or base peak intensity are calculated from the actual spectrum data
 #'     before writing the data to the files.
 #'
-#'     For MSn data, if the `OnDiskMSnExp` or `MSnExp` does not contain also the
-#'     precursor scan of a MS level > 1 spectrum `precursorMZ`,
-#'     `precursorCharge` and `precursorIntensity` of the spectrum is set to 0
-#'     in the output file.
+#'     For MSn data, if the `OnDiskMSnExp` or `MSnExp` does not contain also
+#'     the precursor scan of a MS level > 1 spectrum (e.g. due to filtering on
+#'     the MS level) `precursorScanNum` is set to 0 in the output file to
+#'     avoid potentially linking to a wrong spectrum.
 #' 
 #' @param object `OnDiskMSnExp` or `MSnExp` object.
 #'

diff --git a/man/writeMSData.Rd b/man/writeMSData.Rd