blob: 7138c3f19b854368effef22be6903d02f455fa0c [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="genomics_v1beta.html">Genomics API</a> . <a href="genomics_v1beta.beacons.html">beacons</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Craig Citro0e5b9bf2014-10-15 10:26:14 -070078 <code><a href="#get">get(variantSetId, allele=None, referenceName=None, position=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -070079<p class="firstline">This is an experimental API that provides a Global Alliance for Genomics and Health Beacon. It may change at any time.</p>
80<h3>Method Details</h3>
81<div class="method">
Craig Citro0e5b9bf2014-10-15 10:26:14 -070082 <code class="details" id="get">get(variantSetId, allele=None, referenceName=None, position=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -070083 <pre>This is an experimental API that provides a Global Alliance for Genomics and Health Beacon. It may change at any time.
84
85Args:
Craig Citro0e5b9bf2014-10-15 10:26:14 -070086 variantSetId: string, The ID of the variant set to query over. It must be public. Private variant sets will return an unauthorized exception. (required)
Craig Citro065b5302014-08-14 00:47:23 -070087 allele: string, Required. The allele to look for ('A', 'C', 'G' or 'T').
Craig Citro0e5b9bf2014-10-15 10:26:14 -070088 referenceName: string, Required. The reference to query over.
89 position: string, Required. The 0-based position to query.
Craig Citro065b5302014-08-14 00:47:23 -070090
91Returns:
92 An object of the form:
93
Craig Citro0e5b9bf2014-10-15 10:26:14 -070094 { # A beacon represents whether any variant call in a variant set has a specific allele at a particular position.
Craig Citro065b5302014-08-14 00:47:23 -070095 "exists": True or False, # True if the allele exists on any variant call, false otherwise.
96 }</pre>
97</div>
98
99</body></html>