← Back to branch summary

~ubuntu-branches/ubuntu/vivid/r-cran-readbrukerflexdata/vivid-proposed

« back to all changes in this revision

Viewing changes to man/readBrukerFlexDir.Rd

  • Committer: Package Import Robot
  • Author(s): The Debichem Group
  • Date: 2012-11-11 10:44:00 UTC
  • Revision ID: package-import@ubuntu.com-20121111104400-r035hikf6f67yd6u
Tags: upstream-1.5
Import upstream version 1.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/readBrukerFlexDir.Rd
 
1
\name{readBrukerFlexDir}
 
2
\alias{readBrukerFlexDir}
 
3
\title{Reads recursively mass spectrometry data in Bruker Daltonics' XMASS format.}
 
4
\usage{
 
5
  readBrukerFlexDir(brukerFlexDir,
 
6
    removeCalibrationScans = TRUE, removeMetaData = FALSE,
 
7
    useHpc = TRUE, useSpectraNames = TRUE,
 
8
    filterZeroIntensities = FALSE, verbose = FALSE)
 
9
}
 
10
\arguments{
 
11
  \item{brukerFlexDir}{\code{character}, path to
 
12
  \emph{directory} which should be read recursively.}
 
13
 
 
14
  \item{removeCalibrationScans}{\code{logical}, if
 
15
  \code{TRUE} all scans in directories called
 
16
  \code{[Cc]alibration} will be ignored.}
 
17
 
 
18
  \item{removeMetaData}{\code{logical}, to calculate mass
 
19
  data a lot of meta data are needed. To save memory they
 
20
  could be deleted after calculation.}
 
21
 
 
22
  \item{useHpc}{\code{logical}, should Bruker Daltonics'
 
23
  High Precision Calibration be used if available? (see
 
24
  also: \code{\link[readBrukerFlexData]{.hpc}})}
 
25
 
 
26
  \item{useSpectraNames}{\code{logical}, if \code{TRUE} all
 
27
  list elements get an unique name from metaData otherwise
 
28
  file path is used.  (If \sQuote{removeMetaData} is
 
29
  \code{TRUE} \sQuote{useSpectraNames} has no effect.)}
 
30
 
 
31
  \item{filterZeroIntensities}{\code{logical}, don't change
 
32
  it. If \code{TRUE} all intensities equal \code{0.0} are
 
33
  removed.  (see also:
 
34
  \code{\link[readBrukerFlexData]{readBrukerFlexFile}})}
 
35
 
 
36
  \item{verbose}{\code{logical}, print verbose messages?}
 
37
}
 
38
\value{
 
39
  A \code{list} of spectra. \itemize{
 
40
  \item{\code{[[1]]$spectrum$mass}: }{A vector of
 
41
  calculated mass.} \item{\code{[[1]]$spectrum$intensity}:
 
42
  }{A vector of intensity values.}
 
43
  \item{\code{[[1]]$metaData}: }{A list of metaData
 
44
  depending on read spectrum.} }
 
45
}
 
46
\description{
 
47
  This function leads recursively all mass spectrometry
 
48
  data in Bruker Daltonics' XMASS format in a specified
 
49
  directory.
 
50
}
 
51
\details{
 
52
  See \code{\link[readBrukerFlexData]{readBrukerFlexFile}}.
 
53
}
 
54
\examples{
 
55
## load library
 
56
library("readBrukerFlexData")
 
57
 
 
58
## get examples directory
 
59
exampleDirectory <- system.file("Examples", package="readBrukerFlexData")
 
60
 
 
61
## read example spectra
 
62
spec <- readBrukerFlexDir(file.path(exampleDirectory,
 
63
  "2010_05_19_Gibb_C8_A1"))
 
64
 
 
65
## plot spectra
 
66
plot(spec[[1]]$spectrum$mass, spec[[1]]$spectrum$intensity, type="n")
 
67
 
 
68
l <- length(spec)
 
69
legendStr <- character(l)
 
70
for (i in seq(along=spec)) {
 
71
  lines(spec[[i]]$spectrum$mass, spec[[i]]$spectrum$intensity, type="l",
 
72
        col=rainbow(l)[i])
 
73
  legendStr[i] <- spec[[i]]$metaData$fullName
 
74
}
 
75
 
 
76
## draw legend
 
77
legend(x="topright", legend=legendStr, col=rainbow(l), lwd=1)
 
78
}
 
79
\seealso{
 
80
  \code{\link[readBrukerFlexData]{readBrukerFlexFile}},
 
81
  \code{\link[readBrukerFlexData]{.hpc}}
 
82
}
 
83
\keyword{IO}
 
84