Class: Google::Apis::GenomicsV1beta2::ReadGroup

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

A read group is all the data that's processed the same way by the sequencer.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ReadGroup

Returns a new instance of ReadGroup



1815
1816
1817
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 1815

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

Instance Attribute Details

#dataset_id ⇒ String

The ID of the dataset this read group belongs to. Corresponds to the JSON property datasetId

Returns:

  • (String) 


1761
1762
1763
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 1761

def dataset_id
  @dataset_id
end

#description ⇒ String

A free-form text description of this read group. Corresponds to the JSON property description

Returns:

  • (String) 


1766
1767
1768
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 1766

def description
  @description
end

#experiment ⇒ Google::Apis::GenomicsV1beta2::ReadGroupExperiment

The experiment used to generate this read group. Corresponds to the JSON property experiment

Returns:



1771
1772
1773
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 1771

def experiment
  @experiment
end

#id ⇒ String

The generated unique read group ID. Note: This is different than the @RG ID field in the SAM spec. For that value, see the name field. Corresponds to the JSON property id

Returns:

  • (String) 


1777
1778
1779
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 1777

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>>) 


1782
1783
1784
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 1782

def info
  @info
end

#name ⇒ String

The read group name. This corresponds to the @RG ID field in the SAM spec. Corresponds to the JSON property name

Returns:

  • (String) 


1787
1788
1789
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 1787

def name
  @name
end

#predicted_insert_size ⇒ Fixnum

The predicted insert size of this read group. The insert size is the length the sequenced DNA fragment from end-to-end, not including the adapters. Corresponds to the JSON property predictedInsertSize

Returns:

  • (Fixnum) 


1793
1794
1795
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 1793

def predicted_insert_size
  @predicted_insert_size
end

#programs ⇒ Array<Google::Apis::GenomicsV1beta2::ReadGroupProgram>

The programs used to generate this read group. Programs are always identical for all read groups within a read group set. For this reason, only the first read group in a returned set will have this field populated. Corresponds to the JSON property programs

Returns:



1800
1801
1802
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 1800

def programs
  @programs
end

#reference_set_id ⇒ String

The reference set the reads in this read group are aligned to. Required if there are any read alignments. Corresponds to the JSON property referenceSetId

Returns:

  • (String) 


1806
1807
1808
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 1806

def reference_set_id
  @reference_set_id
end

#sample_id ⇒ String

The sample this read group's data was generated from. Note: This is not an actual ID within this repository, but rather an identifier for a sample which may be meaningful to some external system. Corresponds to the JSON property sampleId

Returns:

  • (String) 


1813
1814
1815
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 1813

def sample_id
  @sample_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
 
# File 'generated/google/apis/genomics_v1beta2/classes.rb', line 1820

def update!(**args)
  @dataset_id = args[:dataset_id] unless args[:dataset_id].nil?
  @description = args[:description] unless args[:description].nil?
  @experiment = args[:experiment] unless args[:experiment].nil?
  @id = args[:id] unless args[:id].nil?
  @info = args[:info] unless args[:info].nil?
  @name = args[:name] unless args[:name].nil?
  @predicted_insert_size = args[:predicted_insert_size] unless args[:predicted_insert_size].nil?
  @programs = args[:programs] unless args[:programs].nil?
  @reference_set_id = args[:reference_set_id] unless args[:reference_set_id].nil?
  @sample_id = args[:sample_id] unless args[:sample_id].nil?
end