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. For more genomics resource definitions, see Fundamentals of Google Genomics 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.


2954
2955
2956
# File 'generated/google/apis/genomics_v1/classes.rb', line 2954

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

Instance Attribute Details

#alternate_basesArray<String>

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

Returns:

  • (Array<String>)

2929
2930
2931
# File 'generated/google/apis/genomics_v1/classes.rb', line 2929

def alternate_bases
  @alternate_bases
end

#callsArray<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


2952
2953
2954
# File 'generated/google/apis/genomics_v1/classes.rb', line 2952

def calls
  @calls
end

#createdString

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

Returns:

  • (String)

2900
2901
2902
# File 'generated/google/apis/genomics_v1/classes.rb', line 2900

def created
  @created
end

#endString

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:

  • (String)

2919
2920
2921
# File 'generated/google/apis/genomics_v1/classes.rb', line 2919

def end
  @end
end

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

2940
2941
2942
# File 'generated/google/apis/genomics_v1/classes.rb', line 2940

def filter
  @filter
end

#idString

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

Returns:

  • (String)

2890
2891
2892
# File 'generated/google/apis/genomics_v1/classes.rb', line 2890

def id
  @id
end

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

2946
2947
2948
# File 'generated/google/apis/genomics_v1/classes.rb', line 2946

def info
  @info
end

#namesArray<String>

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

Returns:

  • (Array<String>)

2895
2896
2897
# File 'generated/google/apis/genomics_v1/classes.rb', line 2895

def names
  @names
end

#qualityFloat

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

Returns:

  • (Float)

2934
2935
2936
# File 'generated/google/apis/genomics_v1/classes.rb', line 2934

def quality
  @quality
end

#reference_basesString

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

Returns:

  • (String)

2924
2925
2926
# File 'generated/google/apis/genomics_v1/classes.rb', line 2924

def reference_bases
  @reference_bases
end

#reference_nameString

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

Returns:

  • (String)

2905
2906
2907
# File 'generated/google/apis/genomics_v1/classes.rb', line 2905

def reference_name
  @reference_name
end

#startString

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:

  • (String)

2911
2912
2913
# File 'generated/google/apis/genomics_v1/classes.rb', line 2911

def start
  @start
end

#variant_set_idString

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

Returns:

  • (String)

2885
2886
2887
# File 'generated/google/apis/genomics_v1/classes.rb', line 2885

def variant_set_id
  @variant_set_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
# File 'generated/google/apis/genomics_v1/classes.rb', line 2959

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