Genomics API . beacons

Instance Methods

get(datasetId, allele=None, position=None, contig=None)

This is an experimental API that provides a Global Alliance for Genomics and Health Beacon. It may change at any time.

Method Details

get(datasetId, allele=None, position=None, contig=None)
This is an experimental API that provides a Global Alliance for Genomics and Health Beacon. It may change at any time.

Args:
  datasetId: string, The ID of the dataset to query over. It must be public. Private datasets will return an unauthorized exception. (required)
  allele: string, Required. The allele to look for ('A', 'C', 'G' or 'T').
  position: string, Required. The 1-based position to query at.
  contig: string, Required. The contig to query over.

Returns:
  An object of the form:

    { # A beacon represents whether any variant call in a dataset has a specific allele at a particular position.
    "exists": True or False, # True if the allele exists on any variant call, false otherwise.
  }