Class: ObservationMatrix

Inherits:
ApplicationRecord show all
Includes:
Housekeeping, Shared::AlternateValues, Shared::Citations, Shared::DataAttributes, Shared::Identifiers, Shared::IsData, Shared::Notes, Shared::Tags
Defined in:
app/models/observation_matrix.rb

Overview

A view to a set of Observations.

Instance Method Summary collapse

Methods included from Shared::IsData

#errors_excepting, #full_error_messages_excepting, #identical, #is_community?, #is_destroyable?, #is_editable?, #is_in_use?, #is_in_users_projects?, #metamorphosize, #similar

Methods included from Shared::AlternateValues

#all_values_for, #alternate_valued?

Methods included from Shared::DataAttributes

#import_attributes, #internal_attributes, #keyword_value_hash, #reject_data_attributes

Methods included from Shared::Notes

#concatenated_notes_string, #reject_notes

Methods included from Shared::Tags

#reject_tags, #tag_with, #tagged?, #tagged_with?

Methods included from Shared::Identifiers

#dwc_occurrence_id, #identified?, #next_by_identifier, #previous_by_identifier, #reject_identifiers

Methods included from Shared::Citations

#cited?, #mark_citations_for_destruction, #nomenclature_date, #origin_citation_source_id, #reject_citations, #requires_citation?, #sources_by_topic_id

Methods included from Housekeeping

#has_polymorphic_relationship?

Methods inherited from ApplicationRecord

transaction_with_retry

Instance Method Details

#cell_countObject

TODO: helper method



73
74
75
# File 'app/models/observation_matrix.rb', line 73

def cell_count
  observation_matrix_rows.count * observation_matrix_columns.count
end

#character_statesObject



68
69
70
# File 'app/models/observation_matrix.rb', line 68

def character_states
  CharacterState.joins(descriptor: [:observation_matrices]).merge(descriptors)
end

#continuous_descriptorsObject



42
43
44
# File 'app/models/observation_matrix.rb', line 42

def continuous_descriptors
  descriptors.where(type: 'Descriptor::Continuous')
end

#empty_grid(opts) ⇒ Array

Returns:

  • (Array)


211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
# File 'app/models/observation_matrix.rb', line 211

def empty_grid(opts)
  re = if opts[:row_end] == 'all'
         observation_matrix_rows.count + 1
       else
         opts[:row_end]
       end

  ce = if opts[:col_end] == 'all'
         observation_matrix_columns.count + 1
       else
         opts[:col_end]
       end

  Array.new(ce - opts[:col_start]){Array.new(re - opts[:row_start]){Array.new}}
end

#gene_descriptorsObject



54
55
56
# File 'app/models/observation_matrix.rb', line 54

def gene_descriptors
  descriptors.where(type: 'Descriptor::Gene')
end

#is_media_matrix?Boolean

Returns True if every descriptor is a media descriptor.

Returns:

  • (Boolean)

    True if every descriptor is a media descriptor



78
79
80
81
82
83
# File 'app/models/observation_matrix.rb', line 78

def is_media_matrix?
  observation_matrix_columns.each do |c|
    return false unless c.descriptor.type == 'Descriptor::Media'
  end
  true
end

#media_descriptorsObject



50
51
52
# File 'app/models/observation_matrix.rb', line 50

def media_descriptors
  descriptors.where(type: 'Descriptor::Media')
end

#media_observationsObject



130
131
132
# File 'app/models/observation_matrix.rb', line 130

def media_observations
  Observation::Media.in_observation_matrix(id)
end

#observation_depictionsObject

TODO: Railsify



135
136
137
138
139
140
141
142
# File 'app/models/observation_matrix.rb', line 135

def observation_depictions
  Depiction.select('depictions.*, observations.descriptor_id, observations.observation_object_id, observations.observation_object_type, sources.id AS source_id, sources.cached_author_string, sources.year, sources.cached AS source_cached')
    .joins("INNER JOIN observations ON observations.id = depictions.depiction_object_id")
    .joins("INNER JOIN images ON depictions.image_id = images.id")
    .joins("LEFT OUTER JOIN citations ON citations.citation_object_id = images.id AND citations.citation_object_type = 'Image' AND citations.is_original IS TRUE")
    .joins("LEFT OUTER JOIN sources ON citations.source_id = sources.id")
    .where(depiction_object: media_observations).order('depictions.position')
end

#observationsObject



126
127
128
# File 'app/models/observation_matrix.rb', line 126

def observations
  Observation.in_observation_matrix(id)
end

#observations_hashHash

Returns a hash of hashes of arrays with the coding objects nicely organized

descriptor_id1 =>{ "Otu1" => [observation1, observation2], descriptor_id: nil}

was `codings_mx` in mx where this: “likely should add scope and merge with above, though this seems to be slower”.

Returns:

  • (Hash)

    a hash of hashes of arrays with the coding objects nicely organized

    descriptor_id1 =>{ "Otu1" => [observation1, observation2], descriptor_id: nil}
    

    was `codings_mx` in mx where this: “likely should add scope and merge with above, though this seems to be slower”



261
262
263
264
265
266
# File 'app/models/observation_matrix.rb', line 261

def observations_hash
  h = Hash.new{|hash, key| hash[key] = Hash.new{|hash2, key2| hash2[key2] = Array.new}}
  observations.each {|o| h[o.descriptor_id][o.observation_object_type + o.observation_object_id.to_s].push(o) }
  #observations.each {|o| h[o.descriptor_id][o.observation_object_global_id].push(o) } ### potentially useful but extra compute slower
  h
end

#observations_in_grid(options = {}) ⇒ Hash

Note: old mx version had additional, at present not needed, they can be added via the row/column_index to get:

rows: [Otu1, Otu2... CollectonObject1]  (was a global ID in mx)
columns: [descriptor.id, desriptor.id]

!! :position attribute starts at 1 !! Grid starts at 0 !!

Returns:

  • (Hash)

    grid: [columns][observations]



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
# File 'app/models/observation_matrix.rb', line 153

def observations_in_grid(options = {})
  opts = {
    row_start:  1,
    row_end: 'all',
    col_start: 1,
    col_end: 'all',
    row_index: false,
    column_index: false,
  }.merge!(options.symbolize_keys)

  return false if (opts[:row_start] == 0) || (opts[:col_start] == 0) # catch problems with forgetting index starts at 1

  grid = empty_grid(opts)

  reindex_row_order if observation_matrix_rows.first.position != 1 || (observation_matrix_rows.last.position != observation_matrix_rows.size)
  reindex_column_order if observation_matrix_columns.first.position != 1 || (observation_matrix_columns.last.position != observation_matrix_columns.size)

  # Dump the observations into bins
  obs = Observation.by_matrix_and_position(self.id, opts)
    .select('omc.position as column_index, omr.position as row_index, observations.*')
  
  rows, cols = [], []

  obs.each do |o|
    grid[o.column_index - 1][o.row_index - 1].push(o)

    # These might not ever be needed, they were used in MX
    if opts[:row_index]
      rows[o.row_index - 1] = o.observation_object_type + o.observation_object_id.to_s if rows[o.row_index - 1].nil?
    end

    if opts[:column_index]
      cols[o.column_index - 1] = o.descriptor_id if cols[o.column_index - 1].nil?
    end
  end

  {grid: grid, rows: rows, cols: cols}
end

#polymorphic_cells_for_descriptor(symbol_start: 0, descriptor_id:) ⇒ Object

Used soley as a indexing method for nexml output Original code in mx

Parameters:

  • descriptor_id (Descriptor)
  • symbol_start (Integer) (defaults to: 0)

    # takes :chr => Chr, :symbol_start => Int

Returns:

  • Hash 1 => [character_state.id, charater_state.id]



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'app/models/observation_matrix.rb', line 233

def polymorphic_cells_for_descriptor(symbol_start: 0, descriptor_id:)
  symbol_start ||= 0
  cells = Hash.new{|hash, key| hash[key] = Array.new}
  observations.where(descriptor_id: descriptor_id).each do |o|
    g = "#{o.observation_object_type}|#{o.observation_object_id}"
    cells[g].push(
      o.qualitative? ? o.character_state_id : "#{o.descriptor_id}_#{o.presence_absence? ? '1' : '0'}"
    )
  end

  r = Hash.new{|hash, key| hash[key] = Array.new}
  i = 0
  cells.keys.each do |k|
    if r # must be some other idiom
      if cells[k].size > 1
        r[symbol_start + i] = cells[k].sort
        i += 1
      end
    end
  end
  r
end

#presence_absence_descriptorsObject



38
39
40
# File 'app/models/observation_matrix.rb', line 38

def presence_absence_descriptors
  descriptors.where(type: 'Descriptor::PresenceAbsence')
end

#qualitative_descriptorsObject



34
35
36
# File 'app/models/observation_matrix.rb', line 34

def qualitative_descriptors
  descriptors.where(type: 'Descriptor::Qualitative')
end

#reindex_column_orderObject



201
202
203
204
205
206
207
208
# File 'app/models/observation_matrix.rb', line 201

def reindex_column_order
  i = 1
  observation_matrix_columns.order(:position).find_each do |o|
    o.update_column(:position, i)
    i += 1
  end
  true 
end

#reindex_row_orderObject



192
193
194
195
196
197
198
199
# File 'app/models/observation_matrix.rb', line 192

def reindex_row_order
  i = 1
  observation_matrix_rows.order(:position).find_each do |o|
    o.update_column(:position, i)
    i += 1
  end
  true 
end

#reorder_columns(by = 'reindex') ⇒ Object



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'app/models/observation_matrix.rb', line 110

def reorder_columns(by = 'reindex')
  case by
  when 'reindex'
    observation_matrix_columns.order('observation_matrix_columns.position').each.with_index do |c,i|
      c.update_column(:position, i)
    end
  when 'name'
    observation_matrix_columns.order('descriptors.name').each.with_index do |c,i|
      c.update_column(:position, i)
    end
  else
    return false
  end
  true
end

#reorder_rows(by = 'reindex') ⇒ Boolean

Returns reorders all rows and returns true or false.

Returns:

  • (Boolean)

    reorders all rows and returns true or false



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'app/models/observation_matrix.rb', line 87

def reorder_rows(by = 'reindex')
  case by
  when 'reindex'
    observation_matrix_rows.order('observation_matrix_rows.position').each.with_index do |r,i|
      r.update_column(:position, i)
    end
  when 'nomenclature'
    objects = []
    observation_matrix_rows.each do |r|
      t = r.current_taxon_name # not all rows have reference to a taxon name
      objects.push [r, (t ? TaxonName.self_and_ancestors_of(t).order('taxon_name_hierarchies.generations DESC').pluck(:name).to_s : '')]
    end

    objects.sort!{|a, b| a[1] <=> b[1]} # add internal loop on name
    objects.each_with_index do |r,i|
      r[0].update_column(:position, i)
    end
  else
    return false
  end
  true
end

#sample_descriptorsObject



46
47
48
# File 'app/models/observation_matrix.rb', line 46

def sample_descriptors
  descriptors.where(type: 'Descriptor::Sample')
end

#symbol_descriptorsObject

As handled in export/parsing by external tools !! Note order() is applied !!



64
65
66
# File 'app/models/observation_matrix.rb', line 64

def symbol_descriptors
  descriptors.where(type: ['Descriptor::PresenceAbsence', 'Descriptor::Qualitative']).order('observation_matrix_columns.position')
end

#working_descriptorsObject



58
59
60
# File 'app/models/observation_matrix.rb', line 58

def working_descriptors
  descriptors.where(type: 'Descriptor::Working')
end