google_api_genomics v0.4.0 GoogleApi.Genomics.V1.Model.Annotation View Source

An annotation describes a region of reference genome. The value of an annotation may be one of several canonical types, supplemented by arbitrary info tags. An annotation is not inherently associated with a specific sample or individual (though a client could choose to use annotations in this way). Example canonical annotation types are `GENE` and `VARIANT`.

Attributes

  • info (%{optional(String.t) => [ErrorUnknown]}): A map of additional read alignment information. This must be of the form map<string, string[]> (string key mapping to a list of string values). Defaults to: null.
  • annotationSetId (String.t): The annotation set to which this annotation belongs. Defaults to: null.
  • end (String.t): The end position of the range on the reference, 0-based exclusive. Defaults to: null.
  • id (String.t): The server-generated annotation ID, unique across all annotations. Defaults to: null.
  • name (String.t): The display name of this annotation. Defaults to: null.
  • referenceId (String.t): The ID of the Google Genomics reference associated with this range. Defaults to: null.
  • referenceName (String.t): The display name corresponding to the reference specified by `referenceId`, for example `chr1`, `1`, or `chrX`. Defaults to: null.
  • reverseStrand (boolean()): Whether this range refers to the reverse strand, as opposed to the forward strand. Note that regardless of this field, the start/end position of the range always refer to the forward strand. Defaults to: null.
  • start (String.t): The start position of the range on the reference, 0-based inclusive. Defaults to: null.
  • transcript (Transcript): A transcript value represents the assertion that a particular region of the reference genome may be transcribed as RNA. An alternative splicing pattern would be represented as a separate transcript object. This field is only set for annotations of type `TRANSCRIPT`. Defaults to: null.
  • type (String.t): The data type for this annotation. Must match the containing annotation set's type. Defaults to: null.

    • Enum - one of [ANNOTATION_TYPE_UNSPECIFIED, GENERIC, VARIANT, GENE, TRANSCRIPT]
  • variant (VariantAnnotation): A variant annotation, which describes the effect of a variant on the genome, the coding sequence, and/or higher level consequences at the organism level e.g. pathogenicity. This field is only set for annotations of type `VARIANT`. Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t() View Source
t() :: %GoogleApi.Genomics.V1.Model.Annotation{
  annotationSetId: any(),
  end: any(),
  id: any(),
  info: map(),
  name: any(),
  referenceId: any(),
  referenceName: any(),
  reverseStrand: any(),
  start: any(),
  transcript: GoogleApi.Genomics.V1.Model.Transcript.t(),
  type: any(),
  variant: GoogleApi.Genomics.V1.Model.VariantAnnotation.t()
}

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.