-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
some content transfer from Beacon v2 documentation
- Loading branch information
Showing
4 changed files
with
41 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Query Types | ||
|
||
## _Sequence Queries_: `VariantSequenceRequest`[^1] | ||
|
||
_Sequence Queries_ query for the existence of a specified sequence at a given genomic | ||
position. Such queries roughly correspond to Beacon v1 queries and are used to match | ||
short, precisely defined genomic variants such as SNVs, MNVs and INDELs. | ||
|
||
## _Range Queries_: `VariantRangeRequest`[^1] | ||
|
||
Beacon _Range Queries_ are supposed to return matches of any variant with at least | ||
partial overlap of the sequence range specified by `referenceName`, `start` and `end` | ||
parameters. | ||
|
||
## _Bracket Queries_ ("CNV queries"): `VariantBracketRequest`[^1] | ||
|
||
_Bracket Queries_ allow the specification of sequence ranges for both start and end | ||
positions of a genomic variation. The typical example here is the query for similar | ||
structural variants - particularly CNVs - affecting a genomic region but potentially | ||
differing in their exact extents. | ||
|
||
## _GeneId Queries_: `GeneRequest`[^1] | ||
|
||
_GeneId Queries_ are in essence a variation of _Range Queries_ in which the coordinates | ||
are replaced by the [HGNC](https://www.genenames.org) gene symbol. It is left to the | ||
implementation if the matching is done on variants annotated for the gene symbol or if | ||
a positional translation is being applied. | ||
|
||
## ==TBC== | ||
|
||
|
||
[^1:] The names of the request type schemas should be considered "malleable". | ||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Variant Types |