Class: Google::Apis::GenomicsV1beta2::Annotation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable
Defined in:
generated/google/apis/genomics_v1beta2/classes.rb,
generated/google/apis/genomics_v1beta2/representations.rb,
generated/google/apis/genomics_v1beta2/representations.rb

Overview

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. A variant annotation is represented by one or more of these canonical types. 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'.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Annotation

Returns a new instance of Annotation



146
147
148
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 146

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#annotation_set_id ⇒ String

The ID of the containing annotation set. Corresponds to the JSON property annotationSetId

Returns:

  • (String) 


106
107
108
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 106

def annotation_set_id
  @annotation_set_id
end

#id ⇒ String

The generated unique ID for this annotation. Corresponds to the JSON property id

Returns:

  • (String) 


111
112
113
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 111

def id
  @id
end

#info ⇒ Hash<String,Array<String>>

A string which maps to an array of values. Corresponds to the JSON property info

Returns:

  • (Hash<String,Array<String>>) 


116
117
118
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 116

def info
  @info
end

#name ⇒ String

The display name of this annotation. Corresponds to the JSON property name

Returns:

  • (String) 


121
122
123
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 121

def name
  @name
end

#position ⇒ Google::Apis::GenomicsV1beta2::RangePosition

A 0-based half-open genomic coordinate range over a reference sequence, for representing the position of a genomic resource. Corresponds to the JSON property position

Returns:



127
128
129
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 127

def position
  @position
end

#transcript ⇒ Google::Apis::GenomicsV1beta2::Transcript

A transcript represents the assertion that a particular region of the reference genome may be transcribed as RNA. Corresponds to the JSON property transcript

Returns:



133
134
135
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 133

def transcript
  @transcript
end

#type ⇒ String

The data type for this annotation. Must match the containing annotation set's type. Corresponds to the JSON property type

Returns:

  • (String) 


139
140
141
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 139

def type
  @type
end

#variant ⇒ Google::Apis::GenomicsV1beta2::VariantAnnotation

A Variant annotation. Corresponds to the JSON property variant

Returns:



144
145
146
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 144

def variant
  @variant
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



151
152
153
154
155
156
157
158
159
160
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 151

def update!(**args)
  @annotation_set_id = args[:annotation_set_id] unless args[:annotation_set_id].nil?
  @id = args[:id] unless args[:id].nil?
  @info = args[:info] unless args[:info].nil?
  @name = args[:name] unless args[:name].nil?
  @position = args[:position] unless args[:position].nil?
  @transcript = args[:transcript] unless args[:transcript].nil?
  @type = args[:type] unless args[:type].nil?
  @variant = args[:variant] unless args[:variant].nil?
end