Class: Aliquot

Inherits:
ApplicationRecord show all
Includes:
DataForSubstitution, AliquotIndexer::AliquotScopes, Api::AliquotIo::Extensions, Api::Messages::FlowcellIo::AliquotExtensions, Api::Messages::QcResultIo::AliquotExtensions, Uuid::Uuidable
Defined in:
app/models/aliquot.rb

Overview

A note on tags: Aliquots can have up to two tags attached, the i7 (tag) and the i5(tag2) Tags are short DNA sequences which can be used to track samples following pooling. If two samples with the same tags are pooled together it becomes impossible to distinguish between them. To avoid this we have an index which ensures unique tags are maintained per pool. (Limitation: This restriction assumes that each oligo sequence is represented only once in the database. This is not the case, so additional slower checks are required where cross tag group pools are possible) MySQL indexes treat NULL values as non identical, so -1 (UNASSIGNED_TAG) is used to represent an untagged well. We have some performance optimizations in place to avoid trying to look up tag -1

See Also:

Defined Under Namespace

Modules: Aliquotable, DataForSubstitution, DeprecatedBehaviours, Remover Classes: InsertSize, TagClash

Constant Summary collapse

TAG_COUNT_NAMES = 
%w[Untagged Single Dual].freeze
UNASSIGNED_TAG =

It may have a tag but not necessarily. If it does, however, that tag needs to be unique within the receptacle. To ensure that there can only be one untagged aliquot present in a receptacle we use a special value for tag_id, rather than NULL which does not work in MySQL. It also works because the unassigned tag ID never gets matched for a Tag and so the result is nil!

-1

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DataForSubstitution

#changes, #generate_substitution_hash, #original_tag2_id, #original_tag_id, #other_attributes_for_substitution, #substitute_tag2_id, #substitute_tag_id, #substitution_hash, #tag2_id_substitution, #tag_id_substitution

Methods included from Api::AliquotIo::Extensions

included

Methods included from AliquotIndexer::AliquotScopes

included

Methods included from Uuid::Uuidable

included, #unsaved_uuid!, #uuid

Methods inherited from ApplicationRecord

alias_association, convert_labware_to_receptacle_for, find_by_id_or_name, find_by_id_or_name!

Methods included from Squishify

extended

Class Method Details

.count_by_project_cost_code ⇒ Object

returns a hash, where keys are cost_codes and values are number of aliquots related to particular cost code {‘cost_code_1’ => 20, ‘cost_code_2’ => 3, ‘cost_code_3’ => 8 } this one does not work, as project is not always there: joins(project: :project_metadata).group(“project_metadata.project_cost_code”).count



99
100
101
102
103
104
 
# File 'app/models/aliquot.rb', line 99

def self.count_by_project_cost_code
  joins('LEFT JOIN projects ON aliquots.project_id = projects.id')
    .joins('LEFT JOIN project_metadata ON project_metadata.project_id = projects.id')
    .group('project_metadata.project_cost_code')
    .count
end

.equivalent_attributes ⇒ Object

Returns a list of attributes which must be the same for two Aliquots to be considered #equivalent? Generated dynamically to avoid accidental introduction of false positives when new columns are added



109
110
111
 
# File 'app/models/aliquot.rb', line 109

def self.equivalent_attributes
  @equivalent_attributes ||= attribute_names - %w[id receptacle_id created_at updated_at]
end

Instance Method Details

#aliquot_index_value ⇒ Object 



113
114
115
 
# File 'app/models/aliquot.rb', line 113

def aliquot_index_value
  aliquot_index.try(:aliquot_index)
end

#created_with_request_options ⇒ Object 



117
118
119
120
121
122
123
 
# File 'app/models/aliquot.rb', line 117

def created_with_request_options
  {
    fragment_size_required_from: insert_size_from,
    fragment_size_required_to: insert_size_to,
    library_type: library_type
  }
end

#dup(params = {}) ⇒ Object

Cloning an aliquot should unset the receptacle ID because otherwise it won’t get reassigned. We should also reset the timestamp information as this is a new aliquot really. Any options passed in as parameters will override the aliquot defaults



181
182
183
 
# File 'app/models/aliquot.rb', line 181

def dup(params = {})
  super().tap { |cloned_aliquot| cloned_aliquot.assign_attributes(params) }
end

#equivalent?(other) ⇒ Boolean

Unlike the above methods, which allow untagged to match with tagged, this looks for exact matches only only id, timestamps and receptacles are excluded

Returns:

  • (Boolean) 


218
219
220
 
# File 'app/models/aliquot.rb', line 218

def equivalent?(other)
  Aliquot.equivalent_attributes.all? { |attrib| send(attrib) == other.send(attrib) }
end

#matches?(object) ⇒ Boolean

rubocop:todo Metrics/PerceivedComplexity, Metrics/MethodLength, Metrics/AbcSize

Returns:

  • (Boolean) 


191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'app/models/aliquot.rb', line 191

def matches?(object) # rubocop:todo Metrics/CyclomaticComplexity
  # NOTE: This function is directional, and assumes that the downstream aliquot
  # is checking the upstream aliquot
  case
  when sample_id != object.sample_id
    false # The samples don't match
  when object.library_id.present? && (library_id != object.library_id)
    false # Our libraries don't match.
  when object.bait_library_id.present? && (bait_library_id != object.bait_library_id)
    false # We have different bait libraries
  when (no_tag1? && object.tag1?) || (no_tag2? && object.tag2?)
    # rubocop:todo Layout/LineLength
    raise StandardError, 'Tag missing from downstream aliquot' # The downstream aliquot is untagged, but is tagged upstream. Something is wrong!
    # rubocop:enable Layout/LineLength
  when object.no_tags?
    true # The upstream aliquot was untagged, we don't need to check tags
  else
    # rubocop:todo Layout/LineLength
    (object.no_tag1? || (tag_id == object.tag_id)) && (object.no_tag2? || (tag2_id == object.tag2_id)) # Both aliquots are tagged, we need to check if they match
    # rubocop:enable Layout/LineLength
  end
end

#no_tag1? ⇒ Boolean

Validating the uniqueness of tags in rails was causing issues, as it was resulting the in the preform_transfer_of_contents in transfer request to fail, without any visible sign that something had gone wrong. This essentially meant that tag clashes would result in sample dropouts. (presumably because << triggers save not save!)

Returns:

  • (Boolean) 


129
130
131
 
# File 'app/models/aliquot.rb', line 129

def no_tag1?
  tag_id == UNASSIGNED_TAG || (tag_id.nil? && tag.nil?)
end

#no_tag2? ⇒ Boolean

Returns:

  • (Boolean) 


137
138
139
 
# File 'app/models/aliquot.rb', line 137

def no_tag2?
  tag2_id == UNASSIGNED_TAG || (tag2_id.nil? && tag2.nil?)
end

#no_tags? ⇒ Boolean

Returns:

  • (Boolean) 


149
150
151
 
# File 'app/models/aliquot.rb', line 149

def no_tags?
  no_tag1? && no_tag2?
end

#set_library(force: false) ⇒ Object 



174
175
176
 
# File 'app/models/aliquot.rb', line 174

def set_library(force: false)
  self.library = receptacle if library.nil? || force
end

#tag ⇒ Object

Optimization: Avoids us hitting the database for untagged aliquots



166
167
168
 
# File 'app/models/aliquot.rb', line 166

def tag
  super unless tag_id == UNASSIGNED_TAG
end

#tag1? ⇒ Boolean

Returns:

  • (Boolean) 


133
134
135
 
# File 'app/models/aliquot.rb', line 133

def tag1?
  !no_tag1?
end

#tag2 ⇒ Object 



170
171
172
 
# File 'app/models/aliquot.rb', line 170

def tag2
  super unless tag2_id == UNASSIGNED_TAG
end

#tag2? ⇒ Boolean

Returns:

  • (Boolean) 


141
142
143
 
# File 'app/models/aliquot.rb', line 141

def tag2?
  !no_tag2?
end

#tag_count_name ⇒ Object 



161
162
163
 
# File 'app/models/aliquot.rb', line 161

def tag_count_name
  TAG_COUNT_NAMES[tag_count]
end

#tags? ⇒ Boolean

Returns:

  • (Boolean) 


145
146
147
 
# File 'app/models/aliquot.rb', line 145

def tags?
  !no_tags?
end

#tags_and_tag_depth_combination ⇒ Object 



157
158
159
 
# File 'app/models/aliquot.rb', line 157

def tags_and_tag_depth_combination
  [tag.try(:oligo), tag2.try(:oligo), tag_depth]
end

#tags_combination ⇒ Object 



153
154
155
 
# File 'app/models/aliquot.rb', line 153

def tags_combination
  [tag.try(:oligo), tag2.try(:oligo)]
end

#update_quality(suboptimal_quality) ⇒ Object 



185
186
187
188
 
# File 'app/models/aliquot.rb', line 185

def update_quality(suboptimal_quality)
  self.suboptimal = suboptimal_quality
  save!
end