← Back to branch summary

~ubuntu-branches/ubuntu/wily/r-bioc-genomicranges/wily-proposed

« back to all changes in this revision

Viewing changes to man/range-squeezers.Rd

  • Committer: Package Import Robot
  • Author(s): Andreas Tille
  • Date: 2014-06-13 15:04:19 UTC
  • mfrom: (1.1.2)
  • Revision ID: package-import@ubuntu.com-20140613150419-v49mxnlg42rnuks5
Tags: 1.16.3-1
* New upstream version
* New (Build-)Depends: r-bioc-genomeinfodb
* cme fix dpkg-control
* add autopkgtest

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/range-squeezers.Rd
 
1
\name{range-squeezers}
 
2
 
 
3
\alias{range-squeezers}
 
4
 
 
5
\alias{granges}
 
6
\alias{grglist}
 
7
\alias{rglist}
 
8
 
 
9
 
 
10
\title{Squeeze the ranges out of a range-based object}
 
11
 
 
12
\description{
 
13
  S4 generic functions for squeezing the ranges out of a range-based object.
 
14
 
 
15
  \code{granges} returns them as a \link{GRanges} object, \code{grglist}
 
16
  as a \link{GRangesList} object, and \code{rglist} as a
 
17
  \link[IRanges]{RangesList} object.
 
18
}
 
19
 
 
20
\usage{
 
21
granges(x, use.mcols=FALSE, ...)
 
22
grglist(x, use.mcols=FALSE, ...)
 
23
rglist(x, use.mcols=FALSE, ...)
 
24
}
 
25
 
 
26
\arguments{
 
27
  \item{x}{
 
28
    A range-based object e.g. a \link{SummarizedExperiment},
 
29
    \link[GenomicAlignments]{GAlignments},
 
30
    \link[GenomicAlignments]{GAlignmentPairs},
 
31
    or \link[GenomicAlignments]{GAlignmentsList} object.
 
32
  }
 
33
  \item{use.mcols}{
 
34
    \code{TRUE} or \code{FALSE} (the default).
 
35
    Whether the metadata columns on \code{x} (accessible with \code{mcols(x)})
 
36
    should be propagated to the returned object or not.
 
37
  }
 
38
  \item{...}{
 
39
    Additional arguments, for use in specific methods.
 
40
  }
 
41
}
 
42
 
 
43
\details{
 
44
  The \pkg{GenomicRanges} and \pkg{GenomicAlignments} packages define and
 
45
  document methods for various types of range-based objects (e.g. for
 
46
  \link{SummarizedExperiment}, \link[GenomicAlignments]{GAlignments},
 
47
  \link[GenomicAlignments]{GAlignmentPairs}, and
 
48
  \link[GenomicAlignments]{GAlignmentsList} objects).
 
49
  Other Bioconductor packages might as well.
 
50
 
 
51
  Note that these functions can be seen as a specific kind of \emph{object
 
52
  getters} as well as functions performing coercion.
 
53
  For some objects (e.g. \link[GenomicAlignments]{GAlignments}),
 
54
  \code{as(x, "GRanges")}, \code{as(x, "GRangesList")}, and
 
55
  \code{as(x, "RangesList")}, are equivalent to
 
56
  \code{granges(x, use.mcols=TRUE)}, \code{grglist(x, use.mcols=TRUE)},
 
57
  and \code{rglist(x, use.mcols=TRUE)}, respectively.
 
58
}
 
59
 
 
60
\value{
 
61
  A \link{GRanges} object for \code{granges}.
 
62
 
 
63
  A \link{GRangesList} object for \code{grglist}.
 
64
 
 
65
  A \link[IRanges]{RangesList} object for \code{rglist}.
 
66
 
 
67
  If \code{x} is a vector-like object (e.g.
 
68
  \link[GenomicAlignments]{GAlignments}), the returned object is expected
 
69
  to be \emph{parallel} to \code{x}, that is, the i-th element in the output
 
70
  corresponds to the i-th element in the input. If \code{x} has names on it,
 
71
  they're propagated to the returned object. If \code{use.mcols} is TRUE and
 
72
  \code{x} has metadata columns on it (accessible with \code{mcols(x)}),
 
73
  they're propagated to the returned object.
 
74
}
 
75
 
 
76
\author{H. Pages}
 
77
 
 
78
\seealso{
 
79
  \itemize{
 
80
    \item \link{GRanges} and \link{GRangesList} objects.
 
81
 
 
82
    \item \link[IRanges]{RangesList} objects in the \pkg{IRanges} package.
 
83
 
 
84
    \item \link{SummarizedExperiment} objects.
 
85
 
 
86
    \item \link[GenomicAlignments]{GAlignments},
 
87
          \link[GenomicAlignments]{GAlignmentPairs},
 
88
          and \link[GenomicAlignments]{GAlignmentsList} objects in the
 
89
          \pkg{GenomicAlignments} package.
 
90
  }
 
91
}
 
92
 
 
93
\examples{
 
94
## See ?GAlignments in the GenomicAlignments package for some
 
95
## examples.
 
96
}
 
97
 
 
98
\keyword{methods}