beacon-v2 BeaconDataset [ ↗ ]

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

Attributes

Type: object
Description: A dataset available in the beacon.

Properties

PropertyType
assemblyIdstring
callCountinteger (int64)
createDateTimestring
dataUseConditionsDataUseConditions.yaml#/ [HTML]
descriptionstring
externalUrlstring
idstring
infoobject
namestring
sampleCountinteger (int64)
updateDateTimestring
variantCountinteger (int64)
versionstring

assemblyId

Assembly identifier (GRC notation, e.g. GRCh37).

assemblyId Value Example
"GRCh38"

callCount

Total number of calls in the dataset.

createDateTime

The time the dataset was created (ISO 8601 format).

createDateTime Value Example
"2012-07-29 or 2017-01-17T20:33:40Z"

dataUseConditions

description

Description of the dataset.

externalUrl

URL to an external system providing more dataset information (RFC 3986 format).

externalUrl Value Example
"http://example.org/wiki/Main_Page"

id

Unique identifier of the dataset.

info

Additional unspecified metadata about the dataset.

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

name

Name of the dataset.

sampleCount

Total number of samples in the dataset.

updateDateTime

The time the dataset was updated in (ISO 8601 format).

updateDateTime Value Example
"2012-07-19 or 2017-01-17T20:33:40Z"

variantCount

Total number of variants in the dataset.

version

Version of the dataset.