Class: RailsDataExplorer::DataSet

Inherits:
Object
  • Object
show all
Defined in:
lib/rails_data_explorer/data_set.rb

Overview

Responsibilities:

* Container for DataSeries

Collaborators:

* DataSeries
* Exploration

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(values_or_data_series, exploration_title) ⇒ DataSet

Returns a new instance of DataSet.

Parameters:

  • values_or_data_series (Array<Numeric, String, Symbol, Nil, Hash, DataSeries>) —

    Array can contain the following:

    • Numeric, String, Symbol, Nil - for a single data series

    • Hash - for multiple data series with the following keys:

      • :name - name for the series as String

      • :values - scalar values as array

      • :chart_roles [Array<Symbol>, optional] - what to use this series for. possible values: :x, :y, :color

      • :data_type (optional) - :quantitative, :categorical, :temporal

    • DataSeries

  • exploration_title (String) —

    used as fall back for data series name



26
27
28
29
 
# File 'lib/rails_data_explorer/data_set.rb', line 26

def initialize(values_or_data_series, exploration_title)
  @data_series = initialize_data_series(values_or_data_series, exploration_title)
  validate_data_series
end

Instance Attribute Details

#data_series ⇒ Object (readonly)

Returns the value of attribute data_series.



14
15
16
 
# File 'lib/rails_data_explorer/data_set.rb', line 14

def data_series
  @data_series
end

Instance Method Details

#available_chart_types ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/rails_data_explorer/data_set.rb', line 78

def available_chart_types
  case dimensions_count
  when 0
    # invalid, handled in validate_data_series
  when 1
    # charts for a single data series, use that series' available_chart_types
    @data_series.first.available_chart_types(dimensions_count: 1).map { |e| e[:chart_class] }
  else
    # TODO: define on each chart type which chart_roles are required.
    # Then use only charts for which all roles are filled.
    # charts for two data series
    # find intersection of all available chart types
    r = @data_series.inject(nil) { |m,ds|
      constraints = { dimensions_count: dimensions_count, chart_roles: ds.chart_roles }
      # initialize m with first data series
      m = ds.available_chart_types(constraints).map { |e| e[:chart_class] }  if m.nil?
      # find intersection of all available_chart_types
      m = ds.available_chart_types(constraints).map { |e| e[:chart_class] } & m
      m
    }
    r
  end
end

#data_series_names ⇒ Object 



139
140
141
 
# File 'lib/rails_data_explorer/data_set.rb', line 139

def data_series_names
  data_series.map { |e| e.name }
end

#descriptive_statistics ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/rails_data_explorer/data_set.rb', line 102

def descriptive_statistics
  case dimensions_count
  when 0
    # invalid, handled in validate_data_series
  when 1
    # charts for a single data series, use that series' descriptive_statistics
    @data_series.first.descriptive_statistics
  when 2
    # charts for two data series
  else
    # charts for multiple data series
  end
end

#dimensions_count ⇒ Object 



74
75
76
 
# File 'lib/rails_data_explorer/data_set.rb', line 74

def dimensions_count
  @data_series.length
end

#initialize_data_series(values_or_data_series, exploration_title) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/rails_data_explorer/data_set.rb', line 31

def initialize_data_series(values_or_data_series, exploration_title)
  case values_or_data_series.first
  when ActiveSupport::TimeWithZone, DateTime, Numeric, NilClass, String, Symbol
    # Array of scalar values, convert to single data series
    [DataSeries.new(exploration_title, values_or_data_series)]
  when Hash
    # Array of Hashes, convert each key/val pair to a data series
    values_or_data_series.map { |data_series_attrs|
      DataSeries.new(
        data_series_attrs.delete(:name),
        data_series_attrs.delete(:values),
        data_series_attrs # pass remaining attrs as options
      )
    }
  when DataSeries
    # return as is
    values_or_data_series
  else
    raise(
      ArgumentError.new(
        "Invalid datum. Only DataSeries, Hash, ActiveSupport::TimeWithZone, DateTime, Numeric, NilClass, String, or Symbol are allowed. " + \
        "Found #{ values_or_data_series.first.class.to_s }."
      )
    )
  end
end

#inspect(indent = 1, recursive = 1000) ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/rails_data_explorer/data_set.rb', line 116

def inspect(indent=1, recursive=1000)
  r = %(#<#{ self.class.to_s }\n)
  r << [
    "@dimensions_count=#{ dimensions_count }",
  ].map { |e| "#{ '  ' * indent }#{ e }\n"}.join
  if recursive > 0
    # data_series
    r << %(#{ '  ' * indent }@data_series=[\n)
    data_series.each do |e|
      r << "#{ '  ' * (indent + 1) }"
      r << e.inspect(indent + 2, recursive - 1)
    end
    r << "#{ '  ' * indent }]\n"
    # available_chart_types
    r << %(#{ '  ' * indent }@available_chart_types=[\n)
    available_chart_types.each do |e|
      r << "#{ '  ' * (indent + 1) }#{ e.inspect }\n"
    end
    r << "#{ '  ' * indent }]\n"
  end
  r << %(#{ '  ' * (indent-1) }>\n)
end

#number_of_values ⇒ Object 



70
71
72
 
# File 'lib/rails_data_explorer/data_set.rb', line 70

def number_of_values
  @data_series.first.number_of_values
end

#validate_data_series ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/rails_data_explorer/data_set.rb', line 58

def validate_data_series
  # all series have same size
  unless 1 == @data_series.map { |e| e.values.length }.uniq.length
    raise(ArgumentError.new("All data series must have same length."))
  end
  # presence of at least one data_series
  if 0 == dimensions_count
    raise(ArgumentError.new("Please provide at least 1 data series."))
  end
  # TODO: all elements in a series are of same type
end