Browse code

refactor: header always returns a `data.frame` (PR #253)

- Fix header for pwiz backend to always return a `data.frame`.
- Update documentation.

jorainer authored on 25/11/2021 08:27:02
Showing 3 changed files

... ...
@@ -2,6 +2,7 @@ CHANGES IN VERSION 2.29.2
2 2
 -------------------------
3 3
  o Update to Proteowizard 3_0_21263
4 4
  o Removed RAMP backend, dropping ability to read mzData
5
+ o header always returns a data.frame even for a single scan.
5 6
 
6 7
 CHANGES IN VERSION 2.29.1
7 8
 -------------------------
... ...
@@ -51,10 +51,6 @@ setMethod("detector", "mzRpwiz",
51 51
 setMethod("header", c("mzRpwiz", "missing"),
52 52
           function(object) {
53 53
               scans <- seq_len(object@backend$getLastScan())
54
-              ## res <- object@backend$getAllScanHeaderInfo()
55
-              ## res$filterString <- as.character(res$filterString)
56
-              ## res$spectrumId <- as.character(res$spectrumId)
57
-              ## res
58 54
               header(object, scans)
59 55
           })
60 56
 
... ...
@@ -63,10 +59,6 @@ setMethod("header", c("mzRpwiz", "numeric"),
63 59
               res <- object@backend$getScanHeaderInfo(scans)
64 60
               res$filterString <- as.character(res$filterString)
65 61
               res$spectrumId <- as.character(res$spectrumId)
66
-              if (length(scans) == 1) {
67
-                  ## Convert data.frame to list to be conform with old code
68
-                  res <- as.list(res)
69
-              }
70 62
               res
71 63
           })
72 64
 
... ...
@@ -98,7 +98,7 @@
98 98
   provided (i.e all spectra in the oject are retured). \code{peaksCount}
99 99
   will return a numeric of length \code{n}.
100 100
   
101
-  The \code{\link{header}} function returns a list containing
101
+  The \code{\link{header}} function returns a \code{data.frame} containing
102 102
   \code{seqNum}, \code{acquisitionNum}, \code{msLevel},
103 103
   \code{peaksCount}, \code{totIonCurrent}, \code{retentionTime} (in
104 104
   seconds), \code{basePeakMZ}, \code{basePeakIntensity},