File: setops-methods.Rd

package info (click to toggle)
r-bioc-genomicalignments 1.0.6-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 2,980 kB
  • ctags: 54
  • sloc: ansic: 1,493; makefile: 4; sh: 3
file content (51 lines) | stat: -rw-r--r-- 1,149 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
\name{setops-methods}
\alias{setops-methods}

\alias{pintersect,GAlignments,GRanges-method}
\alias{pintersect,GRanges,GAlignments-method}


\title{Set operations on GAlignments objects}

\description{
  Performs set operations on \link{GAlignments} objects.
}

\usage{
\S4method{pintersect}{GAlignments,GRanges}(x, y, ...)
\S4method{pintersect}{GRanges,GAlignments}(x, y, ...)
}

\arguments{
  \item{x, y}{
    A \link{GAlignments} object and a \link[GenomicRanges]{GRanges} object.
    They must have the same length.
  }
  \item{...}{
    Further arguments to be passed to or from other methods.
  }
}

\value{
  A \link{GAlignments} object \emph{parallel} to (i.e. same length as)
  \code{x} and \code{y}.
}

\seealso{
  \itemize{
    \item The \link{GAlignments} class.

    \item The \link[GenomicRanges]{setops-methods} man page in the
          \pkg{GenomicRanges} package.
  }
}

\examples{
## Parallel intersection of a GAlignments and a GRanges object:
bamfile <- system.file("extdata", "ex1.bam", package="Rsamtools")
gal <- readGAlignments(bamfile)
pintersect(gal, shift(as(gal, "GRanges"), 6L))
}

\keyword{methods}
\keyword{utilities}