Class: Google::Apis::GenomicsV1::ReadGroupSet

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 set is a logical collection of read groups, which are collections of reads produced by a sequencer. A read group set typically models reads corresponding to one sample, sequenced one way, and aligned one way.

  • A read group set belongs to one dataset.
  • A read group belongs to one read group set.
  • A read belongs to one read group. For more genomics resource definitions, see Fundamentals of Google Genomics

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

Returns a new instance of ReadGroupSet



1928
1929
1930
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1928

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

Instance Attribute Details

#dataset_id ⇒ String

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

Returns:

  • (String) 


1894
1895
1896
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1894

def dataset_id
  @dataset_id
end

#filename ⇒ String

The filename of the original source file for this read group set, if any. Corresponds to the JSON property filename

Returns:

  • (String) 


1899
1900
1901
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1899

def filename
  @filename
end

#id ⇒ String

The server-generated read group set ID, unique for all read group sets. Corresponds to the JSON property id

Returns:

  • (String) 


1904
1905
1906
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1904

def id
  @id
end

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

A map of additional read group set information. Corresponds to the JSON property info

Returns:

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


1909
1910
1911
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1909

def info
  @info
end

#name ⇒ String

The read group set name. By default this will be initialized to the sample name of the sequenced data contained in this set. Corresponds to the JSON property name

Returns:

  • (String) 


1915
1916
1917
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1915

def name
  @name
end

#read_groups ⇒ Array<Google::Apis::GenomicsV1::ReadGroup>

The read groups in this set. There are typically 1-10 read groups in a read group set. Corresponds to the JSON property readGroups

Returns:



1921
1922
1923
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1921

def read_groups
  @read_groups
end

#reference_set_id ⇒ String

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

Returns:

  • (String) 


1926
1927
1928
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1926

def reference_set_id
  @reference_set_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1933
1934
1935
1936
1937
1938
1939
1940
1941
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 1933

def update!(**args)
  @dataset_id = args[:dataset_id] if args.key?(:dataset_id)
  @filename = args[:filename] if args.key?(:filename)
  @id = args[:id] if args.key?(:id)
  @info = args[:info] if args.key?(:info)
  @name = args[:name] if args.key?(:name)
  @read_groups = args[:read_groups] if args.key?(:read_groups)
  @reference_set_id = args[:reference_set_id] if args.key?(:reference_set_id)
end