annmap 'range' functions

Share:

Description

Get the features within the specified genome coordinates.

Usage

  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
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
  domainInRange( x, ..., as.vector = FALSE )
  ## S4 method for signature 'GRanges'
domainInRange( x, as.vector=FALSE )
  ## S4 method for signature 'RangedData'
domainInRange( x, as.vector=FALSE )
  ## S4 method for signature 'character'
domainInRange( x, start, end, strand, ..., as.vector=FALSE )
  ## S4 method for signature 'data.frame'
domainInRange( x, as.vector=FALSE )
  ## S4 method for signature 'NULL'
domainInRange( x, as.vector=FALSE )
  ## S4 method for signature 'factor'
domainInRange( x, start, end, strand, ..., as.vector=FALSE )

  estExonInRange( x, ..., as.vector = FALSE )
  ## S4 method for signature 'GRanges'
estExonInRange( x, as.vector=FALSE )
  ## S4 method for signature 'RangedData'
estExonInRange( x, as.vector=FALSE )
  ## S4 method for signature 'character'
estExonInRange( x, start, end, strand, ..., as.vector=FALSE )
  ## S4 method for signature 'data.frame'
estExonInRange( x, as.vector=FALSE )
  ## S4 method for signature 'NULL'
estExonInRange( x, as.vector=FALSE )
  ## S4 method for signature 'factor'
estExonInRange( x, start, end, strand, ..., as.vector=FALSE )

  estGeneInRange( x, ..., as.vector = FALSE )
  ## S4 method for signature 'GRanges'
estGeneInRange( x, as.vector=FALSE )
  ## S4 method for signature 'RangedData'
estGeneInRange( x, as.vector=FALSE )
  ## S4 method for signature 'character'
estGeneInRange( x, start, end, strand, ..., as.vector=FALSE )
  ## S4 method for signature 'data.frame'
estGeneInRange( x, as.vector=FALSE )
  ## S4 method for signature 'NULL'
estGeneInRange( x, as.vector=FALSE )
  ## S4 method for signature 'factor'
estGeneInRange( x, start, end, strand, ..., as.vector=FALSE )

  estTranscriptInRange( x, ..., as.vector = FALSE )
  ## S4 method for signature 'GRanges'
estTranscriptInRange( x, as.vector=FALSE )
  ## S4 method for signature 'RangedData'
estTranscriptInRange( x, as.vector=FALSE )
  ## S4 method for signature 'character'
estTranscriptInRange( x, start, end, strand, ..., as.vector=FALSE )
  ## S4 method for signature 'data.frame'
estTranscriptInRange( x, as.vector=FALSE )
  ## S4 method for signature 'NULL'
estTranscriptInRange( x, as.vector=FALSE )
  ## S4 method for signature 'factor'
estTranscriptInRange( x, start, end, strand, ..., as.vector=FALSE )

  exonInRange( x, ..., as.vector = FALSE )
  ## S4 method for signature 'GRanges'
exonInRange( x, as.vector=FALSE )
  ## S4 method for signature 'RangedData'
exonInRange( x, as.vector=FALSE )
  ## S4 method for signature 'character'
exonInRange( x, start, end, strand, ..., as.vector=FALSE )
  ## S4 method for signature 'data.frame'
exonInRange( x, as.vector=FALSE )
  ## S4 method for signature 'NULL'
exonInRange( x, as.vector=FALSE )
  ## S4 method for signature 'factor'
exonInRange( x, start, end, strand, ..., as.vector=FALSE )

  geneInRange( x, ..., as.vector = FALSE )
  ## S4 method for signature 'GRanges'
geneInRange( x, as.vector=FALSE )
  ## S4 method for signature 'RangedData'
geneInRange( x, as.vector=FALSE )
  ## S4 method for signature 'character'
geneInRange( x, start, end, strand, ..., as.vector=FALSE )
  ## S4 method for signature 'data.frame'
geneInRange( x, as.vector=FALSE )
  ## S4 method for signature 'NULL'
geneInRange( x, as.vector=FALSE )
  ## S4 method for signature 'factor'
geneInRange( x, start, end, strand, ..., as.vector=FALSE )

  predictionTranscriptInRange( x, ..., as.vector = FALSE )
  ## S4 method for signature 'GRanges'
predictionTranscriptInRange( x, as.vector=FALSE )
  ## S4 method for signature 'RangedData'
predictionTranscriptInRange( x, as.vector=FALSE )
  ## S4 method for signature 'character'
predictionTranscriptInRange( x, start, end, strand, ..., as.vector=FALSE )
  ## S4 method for signature 'data.frame'
predictionTranscriptInRange( x, as.vector=FALSE )
  ## S4 method for signature 'NULL'
predictionTranscriptInRange( x, as.vector=FALSE )
  ## S4 method for signature 'factor'
predictionTranscriptInRange( x, start, end, strand, ..., as.vector=FALSE )

  probesetInRange( x, ..., as.vector = FALSE )
  ## S4 method for signature 'GRanges'
probesetInRange( x, as.vector=FALSE )
  ## S4 method for signature 'RangedData'
probesetInRange( x, as.vector=FALSE )
  ## S4 method for signature 'character'
probesetInRange( x, start, end, strand, ..., as.vector=FALSE )
  ## S4 method for signature 'data.frame'
probesetInRange( x, as.vector=FALSE )
  ## S4 method for signature 'NULL'
probesetInRange( x, as.vector=FALSE )
  ## S4 method for signature 'factor'
probesetInRange( x, start, end, strand, ..., as.vector=FALSE )

  probeInRange( x, ..., as.vector = FALSE )
  ## S4 method for signature 'GRanges'
probeInRange( x, as.vector=FALSE )
  ## S4 method for signature 'RangedData'
probeInRange( x, as.vector=FALSE )
  ## S4 method for signature 'character'
probeInRange( x, start, end, strand, ..., as.vector=FALSE )
  ## S4 method for signature 'data.frame'
probeInRange( x, as.vector=FALSE )
  ## S4 method for signature 'NULL'
probeInRange( x, as.vector=FALSE )
  ## S4 method for signature 'factor'
probeInRange( x, start, end, strand, ..., as.vector=FALSE )

  proteinInRange( x, ..., as.vector = FALSE )
  ## S4 method for signature 'GRanges'
proteinInRange( x, as.vector=FALSE )
  ## S4 method for signature 'RangedData'
proteinInRange( x, as.vector=FALSE )
  ## S4 method for signature 'character'
proteinInRange( x, start, end, strand, ..., as.vector=FALSE )
  ## S4 method for signature 'data.frame'
proteinInRange( x, as.vector=FALSE )
  ## S4 method for signature 'NULL'
proteinInRange( x, as.vector=FALSE )
  ## S4 method for signature 'factor'
proteinInRange( x, start, end, strand, ..., as.vector=FALSE )

  transcriptInRange( x, ..., as.vector = FALSE )
  ## S4 method for signature 'GRanges'
transcriptInRange( x, as.vector=FALSE )
  ## S4 method for signature 'RangedData'
transcriptInRange( x, as.vector=FALSE )
  ## S4 method for signature 'character'
transcriptInRange( x, start, end, strand, ..., as.vector=FALSE )
  ## S4 method for signature 'data.frame'
transcriptInRange( x, as.vector=FALSE )
  ## S4 method for signature 'NULL'
transcriptInRange( x, as.vector=FALSE )
  ## S4 method for signature 'factor'
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.

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).

Value

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

Author(s)

Tim Yates

See Also

annmapTo
annmapDetails
annmapAll
annmapUtils
annmapFilters
RangedData GRanges

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
  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' ) ) ) )
  }