Skip to content

Commit

Permalink
Clarifies relationship between coercion to GRanges/GRangesList/Ranges…
Browse files Browse the repository at this point in the history
…List and

range-squeezers granges(), grglist(), and rglist().


git-svn-id: https://hedgehog.fhcrc.org/bioconductor/trunk/madman/Rpacks/GenomicRanges@86946 bc3139a8-67e5-0310-9ffc-ced21a209358
  • Loading branch information
[email protected] committed Feb 28, 2014
1 parent ee2b3a1 commit 622f7fb
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions man/range-squeezers.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,10 @@ rglist(x, use.mcols=FALSE, ...)
Note that these functions can be seen as a specific kind of \emph{object
getters} as well as functions performing coercion.
For some objects (e.g. \link[GenomicAlignments]{GAlignments}),
\code{granges(x)}, \code{grglist(x)}, and \code{rglist(x)} are actually
equivalent to \code{as(x, "GRanges")}, \code{as(x, "GRangesList")},
and \code{as(x, "RangesList")}, respectively.
\code{as(x, "GRanges")}, \code{as(x, "GRangesList")}, and
\code{as(x, "RangesList")}, are equivalent to
\code{granges(x, use.mcols=TRUE)}, \code{grglist(x, use.mcols=TRUE)},
and \code{rglist(x, use.mcols=TRUE)}, respectively.
}

\value{
Expand Down

0 comments on commit 622f7fb

Please sign in to comment.