Browse code

Use \S4method to document peaks method; see #134

Sebastian Gibb authored on 22/11/2017 21:09:12
Showing 1 changed files

... ...
@@ -45,9 +45,13 @@
45 45
 
46 46
  peaksCount(object, scans, ...)
47 47
 
48
- peaks(object, ...) 
48
+ \S4method{peaks}{mzRpwiz}(object, scans)
49
+ \S4method{peaks}{mzRramp}(object, scans)
50
+ \S4method{peaks}{mzRnetCDF}(object, scans)
49 51
 
50
- spectra(object, ...) ## same as peaks
52
+ \S4method{spectra}{mzRpwiz}(object, scans)   ## same as peaks
53
+ \S4method{spectra}{mzRramp}(object, scans)
54
+ \S4method{spectra}{mzRnetCDF}(object, scans)
51 55
 
52 56
  get3Dmap(object, scans, lowMz, highMz, resMz, ...)
53 57
 
... ...
@@ -66,7 +70,7 @@
66 70
   \item{object}{An instantiated \code{mzR} object.}
67 71
   
68 72
   \item{scans}{A \code{numeric} specifying which scans to
69
-    return. Optional for the \code{header}, \code{peaks}, \code{scans}
73
+    return. Optional for the \code{header}, \code{peaks}, \code{spectra}
70 74
     and \code{peaksCount} methods. If ommited, the requested data for
71 75
     all peaks is returned. }
72 76
 
... ...
@@ -177,7 +181,7 @@
177 181
  colnames(header(mz))
178 182
  close(mz)
179 183
 
180
- ## A shortgun LCMSMS experiment 
184
+ ## A shotgun LCMSMS experiment
181 185
  f <- proteomics(full.names = TRUE,
182 186
                  pattern = "TMT_Erwinia_1uLSike_Top10HCD_isol2_45stepped_60min_01.mzML.gz")
183 187
  x <- openMSfile(f, backend = "pwiz")
... ...
@@ -187,7 +191,10 @@
187 191
  head(chromatogram(x, 1L)) ## same as tic(x)
188 192
  str(chromatogram(x)) ## as a list
189 193
 
190
- ## An MRM experiment 
194
+ peaks(x) ## extract all peak information
195
+ peaks(x, scan=4) ## extract just peaks from the 4th scan
196
+
197
+ ## An MRM experiment
191 198
  f <- proteomics(full.names = TRUE, pattern = "MRM")
192 199
  x <- openMSfile(f, backend = "pwiz")
193 200
  x