Class: Google::Apis::GenomicsV1::Variant

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 variant represents a change in DNA sequence relative to a reference sequence. For example, a variant could represent a SNP or an insertion. Variants belong to a variant set. Each of the calls on a variant represent a determination of genotype with respect to that variant. For example, a call might assign probability of 0.32 to the occurrence of a SNP named rs1234 in a sample named NA12345. A call belongs to a call set, which contains related calls typically from one sample.

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

Returns a new instance of Variant



3516
3517
3518
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3516

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

Instance Attribute Details

#alternate_bases ⇒ Array<String>

The bases that appear instead of the reference bases. Corresponds to the JSON property alternateBases

Returns:

  • (Array<String>) 


3444
3445
3446
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3444

def alternate_bases
  @alternate_bases
end

#calls ⇒ Array<Google::Apis::GenomicsV1::VariantCall>

The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant. Corresponds to the JSON property calls

Returns:



3450
3451
3452
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3450

def calls
  @calls
end

#created ⇒ Fixnum

The date this variant was created, in milliseconds from the epoch. Corresponds to the JSON property created

Returns:

  • (Fixnum) 


3455
3456
3457
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3455

def created
  @created
end

#end ⇒ Fixnum

The end position (0-based) of this variant. This corresponds to the first base after the last base in the reference allele. So, the length of the reference allele is (end - start). This is useful for variants that don't explicitly give alternate bases, for example large deletions. Corresponds to the JSON property end

Returns:

  • (Fixnum) 


3463
3464
3465
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3463

def end
  @end
end

#filter ⇒ Array<String>

A list of filters (normally quality filters) this variant has failed. PASS indicates this variant has passed all filters. Corresponds to the JSON property filter

Returns:

  • (Array<String>) 


3469
3470
3471
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3469

def filter
  @filter
end

#id ⇒ String

The server-generated variant ID, unique across all variants. Corresponds to the JSON property id

Returns:

  • (String) 


3474
3475
3476
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3474

def id
  @id
end

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

A map of additional variant 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>>) 


3480
3481
3482
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3480

def info
  @info
end

#names ⇒ Array<String>

Names for the variant, for example a RefSNP ID. Corresponds to the JSON property names

Returns:

  • (Array<String>) 


3485
3486
3487
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3485

def names
  @names
end

#quality ⇒ Float

A measure of how likely this variant is to be real. A higher value is better. Corresponds to the JSON property quality

Returns:

  • (Float) 


3491
3492
3493
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3491

def quality
  @quality
end

#reference_bases ⇒ String

The reference bases for this variant. They start at the given position. Corresponds to the JSON property referenceBases

Returns:

  • (String) 


3497
3498
3499
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3497

def reference_bases
  @reference_bases
end

#reference_name ⇒ String

The reference on which this variant occurs. (such as chr20 or X) Corresponds to the JSON property referenceName

Returns:

  • (String) 


3503
3504
3505
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3503

def reference_name
  @reference_name
end

#start ⇒ Fixnum

The position at which this variant occurs (0-based). This corresponds to the first base of the string of reference bases. Corresponds to the JSON property start

Returns:

  • (Fixnum) 


3509
3510
3511
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3509

def start
  @start
end

#variant_set_id ⇒ String

The ID of the variant set this variant belongs to. Corresponds to the JSON property variantSetId

Returns:

  • (String) 


3514
3515
3516
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3514

def variant_set_id
  @variant_set_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3521

def update!(**args)
  @alternate_bases = args[:alternate_bases] if args.key?(:alternate_bases)
  @calls = args[:calls] if args.key?(:calls)
  @created = args[:created] if args.key?(:created)
  @end = args[:end] if args.key?(:end)
  @filter = args[:filter] if args.key?(:filter)
  @id = args[:id] if args.key?(:id)
  @info = args[:info] if args.key?(:info)
  @names = args[:names] if args.key?(:names)
  @quality = args[:quality] if args.key?(:quality)
  @reference_bases = args[:reference_bases] if args.key?(:reference_bases)
  @reference_name = args[:reference_name] if args.key?(:reference_name)
  @start = args[:start] if args.key?(:start)
  @variant_set_id = args[:variant_set_id] if args.key?(:variant_set_id)
end