beacon-v2 BeaconDatasetAlleleResponse [ ↗ ]

{S}[B] Status [i]
proposed
Provenance
Used by
Contributors
Source (2.0.0-draft.3)

Attributes

Type: object
Description: Response containing information about an allele in a particular dataset.

Properties

PropertyType
callCountinteger (int64)
datasetHandoverarray of "Handover.yaml#/ [HTML]"
datasetIdstring
existsboolean
externalUrlstring
frequencynumber
infoobject
notestring
sampleCountinteger (int64)
variantCountinteger (int64)

callCount

Total number of calls in the dataset. Missing calls are not included.

datasetHandover

datasetId

id of the dataset.

exists

Indicator of whether the given allele was observed in the dataset. This should be non-null, unless there was an error, in which case error has to be non-null.

externalUrl

URL to an external system, such as a secured beacon or a system providing more information about a given allele (RFC 3986 format).

frequency

Frequency of this allele in the dataset. Between 0 and 1, inclusive.

info

Additional unspecified metadata about the dataset response or its content.

info Value Example
{
   "additionalInfoKey1" : [
      "additionalInfoValue1",
      "additionalInfoValue2]"
   ],
   "additionalInfoKey2" : "additionalInfoValue3"
}

note

Additional note or description of the response.

sampleCount

Number of samples in the dataset where the requested allele is found.

variantCount

Number of times the requested allele has been observed in the dataset.