annmap (version 1.14.0)

annmapRange: annmap 'range' functions

Description

Get the features within the specified genome coordinates.

Usage

domainInRange( x, ..., as.vector = FALSE ) "domainInRange"( x, as.vector=FALSE ) "domainInRange"( x, as.vector=FALSE ) "domainInRange"( x, start, end, strand, ..., as.vector=FALSE ) "domainInRange"( x, as.vector=FALSE ) "domainInRange"( x, as.vector=FALSE ) "domainInRange"( x, start, end, strand, ..., as.vector=FALSE )
  estExonInRange( x, ..., as.vector = FALSE ) "estExonInRange"( x, as.vector=FALSE ) "estExonInRange"( x, as.vector=FALSE ) "estExonInRange"( x, start, end, strand, ..., as.vector=FALSE ) "estExonInRange"( x, as.vector=FALSE ) "estExonInRange"( x, as.vector=FALSE ) "estExonInRange"( x, start, end, strand, ..., as.vector=FALSE )
  estGeneInRange( x, ..., as.vector = FALSE ) "estGeneInRange"( x, as.vector=FALSE ) "estGeneInRange"( x, as.vector=FALSE ) "estGeneInRange"( x, start, end, strand, ..., as.vector=FALSE ) "estGeneInRange"( x, as.vector=FALSE ) "estGeneInRange"( x, as.vector=FALSE ) "estGeneInRange"( x, start, end, strand, ..., as.vector=FALSE )
  estTranscriptInRange( x, ..., as.vector = FALSE ) "estTranscriptInRange"( x, as.vector=FALSE ) "estTranscriptInRange"( x, as.vector=FALSE ) "estTranscriptInRange"( x, start, end, strand, ..., as.vector=FALSE ) "estTranscriptInRange"( x, as.vector=FALSE ) "estTranscriptInRange"( x, as.vector=FALSE ) "estTranscriptInRange"( x, start, end, strand, ..., as.vector=FALSE )
  exonInRange( x, ..., as.vector = FALSE ) "exonInRange"( x, as.vector=FALSE ) "exonInRange"( x, as.vector=FALSE ) "exonInRange"( x, start, end, strand, ..., as.vector=FALSE ) "exonInRange"( x, as.vector=FALSE ) "exonInRange"( x, as.vector=FALSE ) "exonInRange"( x, start, end, strand, ..., as.vector=FALSE )
  geneInRange( x, ..., as.vector = FALSE ) "geneInRange"( x, as.vector=FALSE ) "geneInRange"( x, as.vector=FALSE ) "geneInRange"( x, start, end, strand, ..., as.vector=FALSE ) "geneInRange"( x, as.vector=FALSE ) "geneInRange"( x, as.vector=FALSE ) "geneInRange"( x, start, end, strand, ..., as.vector=FALSE )
  predictionTranscriptInRange( x, ..., as.vector = FALSE ) "predictionTranscriptInRange"( x, as.vector=FALSE ) "predictionTranscriptInRange"( x, as.vector=FALSE ) "predictionTranscriptInRange"( x, start, end, strand, ..., as.vector=FALSE ) "predictionTranscriptInRange"( x, as.vector=FALSE ) "predictionTranscriptInRange"( x, as.vector=FALSE ) "predictionTranscriptInRange"( x, start, end, strand, ..., as.vector=FALSE )
  probesetInRange( x, ..., as.vector = FALSE ) "probesetInRange"( x, as.vector=FALSE ) "probesetInRange"( x, as.vector=FALSE ) "probesetInRange"( x, start, end, strand, ..., as.vector=FALSE ) "probesetInRange"( x, as.vector=FALSE ) "probesetInRange"( x, as.vector=FALSE ) "probesetInRange"( x, start, end, strand, ..., as.vector=FALSE )
  probeInRange( x, ..., as.vector = FALSE ) "probeInRange"( x, as.vector=FALSE ) "probeInRange"( x, as.vector=FALSE ) "probeInRange"( x, start, end, strand, ..., as.vector=FALSE ) "probeInRange"( x, as.vector=FALSE ) "probeInRange"( x, as.vector=FALSE ) "probeInRange"( x, start, end, strand, ..., as.vector=FALSE )
  proteinInRange( x, ..., as.vector = FALSE ) "proteinInRange"( x, as.vector=FALSE ) "proteinInRange"( x, as.vector=FALSE ) "proteinInRange"( x, start, end, strand, ..., as.vector=FALSE ) "proteinInRange"( x, as.vector=FALSE ) "proteinInRange"( x, as.vector=FALSE ) "proteinInRange"( x, start, end, strand, ..., as.vector=FALSE )
  transcriptInRange( x, ..., as.vector = FALSE ) "transcriptInRange"( x, as.vector=FALSE ) "transcriptInRange"( x, as.vector=FALSE ) "transcriptInRange"( x, start, end, strand, ..., as.vector=FALSE ) "transcriptInRange"( x, as.vector=FALSE ) "transcriptInRange"( x, as.vector=FALSE ) "transcriptInRange"( x, start, end, strand, ..., as.vector=FALSE )

Arguments

as.vector

If TRUE returns a vector of database identifiers. If FALSE returns a GRanges object containing detailed annotation.

x

The name of the chromosome of interest -- in the case of the factor or character variants), or a GRanges object or data.frame containing location information. In the case of a data.frame, columns must be named chr or chromosome_name, followed by start, end and strand. RangedData objects must contain a strand in their meta-data. And strand must be 1 or -1 in all cases arart from GRanges where it obviously has to be + or -. All of the NULL variants simply return NULL, in-keeping with the fluent style of the rest of the package.

start

Start of the region

end

End of the region

strand

1 == top stand, -1 == bottom strand

...

The ellipsis is to allow this multi-method style of programming.

Value

Returns a GRanges object, one \'row\' per feature, containing detailed annotations, or a vector of identifiers, depending on the value of as.vector.

Details

Find all the specified features within a given region of the genome. For all functions except probeInRange, features that fall on the boundaries of the region (i.e. are partially overlapping) are returned too. For probeInRange probes that span the start of the range are NOT returned (but those spanning the end of the range are).

The function annmapRangeApply makes it possible to map any of these functions down the rows of a RangedData or GRanges object. The defaults are set up so that it will handle the output of one of the InRange methods here. This makes it easy to nest functions, for example, to find all genes in a given region of the the genome, and then find the exon array probes that map to those genes (see below).

See Also

annmapTo annmapDetails annmapAll annmapUtils annmapFilters RangedData GRanges

Examples

  if(interactive()) {
    annmapConnect()

    r = geneInRange( '17', 7510000, 7550000, 1 )

    # Can take equal length vectors as parameters
    geneInRange( c( '17', 'X' ), c( 7510000, 1000000 ), c( 7550000, 1500000 ), c( -1, -1 ) )

    # Or a data.frame
    df = data.frame( chr=c( '17', 'X' ), start=c( 7510000, 1000000 ), end=c( 7550000, 1500000 ), strand=c( -1, -1 ) )
    geneInRange( df )

    # Or RangedData objects
    transcriptInRange( geneDetails( symbolToGene( c( 'tp53', 'ssh' ) ) ) )
  }