Variant index
gentropy.dataset.variant_index.VariantIndex
dataclass
¶
Bases: Dataset
Dataset for representing variants and methods applied on them.
Source code in src/gentropy/dataset/variant_index.py
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 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 |
|
add_annotation(annotation_source: VariantIndex) -> VariantIndex
¶
Import annotation from an other variant index dataset.
At this point the annotation can be extended with extra cross-references, in-silico predictions and allele frequencies.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
annotation_source
|
VariantIndex
|
Annotation to add to the dataset |
required |
Returns:
Name | Type | Description |
---|---|---|
VariantIndex |
VariantIndex
|
VariantIndex dataset with the annotation added |
Source code in src/gentropy/dataset/variant_index.py
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 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
|
filter_by_variant(df: DataFrame) -> VariantIndex
¶
Filter variant annotation dataset by a variant dataframe.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
df
|
DataFrame
|
A dataframe of variants |
required |
Returns:
Name | Type | Description |
---|---|---|
VariantIndex |
VariantIndex
|
A filtered variant annotation dataset |
Source code in src/gentropy/dataset/variant_index.py
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
|
get_distance_to_gene(*, distance_type: str = 'distanceFromTss', max_distance: int = 500000) -> DataFrame
¶
Extracts variant to gene assignments for variants falling within a window of a gene's TSS or footprint.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
distance_type
|
str
|
The type of distance to use. Can be "distanceFromTss" or "distanceFromFootprint". Defaults to "distanceFromTss". |
'distanceFromTss'
|
max_distance
|
int
|
The maximum distance to consider. Defaults to 500_000, the default window size for VEP. |
500000
|
Returns:
Name | Type | Description |
---|---|---|
DataFrame |
DataFrame
|
A dataframe with the distance between a variant and a gene's TSS or footprint. |
Raises:
Type | Description |
---|---|
ValueError
|
Invalid distance type. |
Source code in src/gentropy/dataset/variant_index.py
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
|
get_loftee() -> DataFrame
¶
Returns a dataframe with a flag indicating whether a variant is predicted to cause loss of function in a gene. The source of this information is the LOFTEE algorithm (https://github.com/konradjk/loftee).
!!! note, "This will return a filtered dataframe with only variants that have been annotated by LOFTEE."
Returns:
Name | Type | Description |
---|---|---|
DataFrame |
DataFrame
|
variant to gene assignments from the LOFTEE algorithm |
Source code in src/gentropy/dataset/variant_index.py
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 |
|
get_schema() -> StructType
classmethod
¶
Provides the schema for the variant index dataset.
Returns:
Name | Type | Description |
---|---|---|
StructType |
StructType
|
Schema for the VariantIndex dataset |
Source code in src/gentropy/dataset/variant_index.py
61 62 63 64 65 66 67 68 |
|
hash_long_variant_ids(variant_id: Column, chromosome: Column, position: Column, threshold: int) -> Column
staticmethod
¶
Hash long variant identifiers.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
variant_id
|
Column
|
Column containing variant identifiers. |
required |
chromosome
|
Column
|
Chromosome column. |
required |
position
|
Column
|
position column. |
required |
threshold
|
int
|
Above this limit, a hash will be generated. |
required |
Returns:
Name | Type | Description |
---|---|---|
Column |
Column
|
Hashed variant identifiers for long variants. |
Examples:
>>> (
... spark.createDataFrame([('v_short', 'x', 23),('v_looooooong', '23', 23), ('no_chrom', None, None), (None, None, None)], ['variantId', 'chromosome', 'position'])
... .select('variantId', VariantIndex.hash_long_variant_ids(f.col('variantId'), f.col('chromosome'), f.col('position'), 10).alias('hashedVariantId'))
... .show(truncate=False)
... )
+------------+--------------------------------------------+
|variantId |hashedVariantId |
+------------+--------------------------------------------+
|v_short |v_short |
|v_looooooong|OTVAR_23_23_3749d019d645894770c364992ae70a05|
|no_chrom |OTVAR_41acfcd7d4fd523b33600b504914ef25 |
|null |null |
+------------+--------------------------------------------+
Source code in src/gentropy/dataset/variant_index.py
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 |
|
max_maf() -> Column
¶
Maximum minor allele frequency accross all populations assuming all variants biallelic.
Returns:
Name | Type | Description |
---|---|---|
Column |
Column
|
Maximum minor allele frequency accross all populations. |
Raises:
Type | Description |
---|---|
ValueError
|
Allele frequencies are not present in the dataset. |
Source code in src/gentropy/dataset/variant_index.py
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
|
Schema¶
root
|-- variantId: string (nullable = false)
|-- chromosome: string (nullable = false)
|-- position: integer (nullable = false)
|-- referenceAllele: string (nullable = false)
|-- alternateAllele: string (nullable = false)
|-- inSilicoPredictors: array (nullable = true)
| |-- element: struct (containsNull = true)
| | |-- method: string (nullable = true)
| | |-- assessment: string (nullable = true)
| | |-- score: float (nullable = true)
| | |-- assessmentFlag: string (nullable = true)
| | |-- targetId: string (nullable = true)
| | |-- normalisedScore: double (nullable = true)
|-- mostSevereConsequenceId: string (nullable = true)
|-- transcriptConsequences: array (nullable = true)
| |-- element: struct (containsNull = false)
| | |-- variantFunctionalConsequenceIds: array (nullable = true)
| | | |-- element: string (containsNull = true)
| | |-- aminoAcidChange: string (nullable = true)
| | |-- uniprotAccessions: array (nullable = true)
| | | |-- element: string (containsNull = true)
| | |-- isEnsemblCanonical: boolean (nullable = false)
| | |-- codons: string (nullable = true)
| | |-- distanceFromFootprint: long (nullable = true)
| | |-- distanceFromTss: long (nullable = true)
| | |-- appris: string (nullable = true)
| | |-- maneSelect: string (nullable = true)
| | |-- targetId: string (nullable = true)
| | |-- impact: string (nullable = true)
| | |-- lofteePrediction: string (nullable = true)
| | |-- siftPrediction: float (nullable = true)
| | |-- polyphenPrediction: float (nullable = true)
| | |-- consequenceScore: float (nullable = true)
| | |-- transcriptIndex: integer (nullable = true)
| | |-- approvedSymbol: string (nullable = true)
| | |-- biotype: string (nullable = true)
| | |-- transcriptId: string (nullable = true)
|-- rsIds: array (nullable = true)
| |-- element: string (containsNull = true)
|-- hgvsId: string (nullable = true)
|-- alleleFrequencies: array (nullable = true)
| |-- element: struct (containsNull = true)
| | |-- populationName: string (nullable = true)
| | |-- alleleFrequency: double (nullable = true)
|-- dbXrefs: array (nullable = true)
| |-- element: struct (containsNull = true)
| | |-- id: string (nullable = true)
| | |-- source: string (nullable = true)
|-- variantDescription: string (nullable = true)