Class: Google::Apis::GenomicsV1::ReadGroup

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/genomics_v1/classes.rb,
generated/google/apis/genomics_v1/representations.rb,
generated/google/apis/genomics_v1/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::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ReadGroup

Returns a new instance of ReadGroup



2044
2045
2046
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2044

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

Instance Attribute Details

#dataset_id ⇒ String

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

Returns:

  • (String) 


1990
1991
1992
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1990

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) 


1995
1996
1997
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1995

def description
  @description
end

#experiment ⇒ Google::Apis::GenomicsV1::Experiment

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

Returns:



2000
2001
2002
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2000

def experiment
  @experiment
end

#id ⇒ String

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

Returns:

  • (String) 


2007
2008
2009
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2007

def id
  @id
end

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

A map of additional read group information. This must be of the form map (string key mapping to a list of string values). Corresponds to the JSON property info

Returns:

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


2013
2014
2015
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2013

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) 


2018
2019
2020
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2018

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) 


2024
2025
2026
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2024

def predicted_insert_size
  @predicted_insert_size
end

#programs ⇒ Array<Google::Apis::GenomicsV1::Program>

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:



2032
2033
2034
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2032

def programs
  @programs
end

#reference_set_id ⇒ String

The reference set the reads in this read group are aligned to. Corresponds to the JSON property referenceSetId

Returns:

  • (String) 


2037
2038
2039
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2037

def reference_set_id
  @reference_set_id
end

#sample_id ⇒ String

A client-supplied sample identifier for the reads in this read group. Corresponds to the JSON property sampleId

Returns:

  • (String) 


2042
2043
2044
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2042

def sample_id
  @sample_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2049

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