Module: RedAmber::DataFrameDisplayable

Included in:
DataFrame
Defined in:
lib/red_amber/data_frame_displayable.rb

Overview

Mix-in for the class DataFrame

Instance Method Summary collapse

Instance Method Details

#inspect ⇒ String

Show information of self.

According to ‘ENV [“RED_AMBER_OUTPUT_MODE”].upcase`,

  • If it is ‘TDR’, returns class name, shape, object id and transposed preview for up to 10 variables.

  • If it is ‘TDRA’, returns class name, shape, object id and transposed preview for all variables.

  • If it is ‘MINIMUM’, returns class name and shape.

  • If it is ‘PLAIN’, returns class name, shape and Table preview for up to 512 columns and 128 columns.

  • If it is ‘TABLE’ or otherwise, returns class name, shape, object id and Table preview for up to 512 rows and 512 columns. Default value of the ENV is ‘Table’.

Examples:

Default for ENV [‘RED_AMBER_OUTPUT_MODE’] == ‘Table’

puts df.inspect

# =>
#<RedAmber::DataFrame : 3 x 2 Vectors, 0x000000000000c148>
        x y
  <uint8> <string>
0       1 A
1       2 B
2       3 C

In case of ENV [‘RED_AMBER_OUTPUT_MODE’] == ‘TDR’

puts df.inspect

# =>
#<RedAmber::DataFrame : 3 x 2 Vectors, 0x000000000000c148>
Vectors : 1 numeric, 1 string
# key type   level data_preview
0 :x  uint8      3 [1, 2, 3]
1 :y  string     3 ["A", "B", "C"]

In case of ENV [‘RED_AMBER_OUTPUT_MODE’] == ‘Minimum’

puts df.inspect

# =>
RedAmber::DataFrame : 3 x 2 Vectors

Returns:

  • (String) —

    information of self.



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/red_amber/data_frame_displayable.rb', line 129

def inspect
  mode = ENV.fetch('RED_AMBER_OUTPUT_MODE', 'Table')
  case mode.upcase
  when 'TDR'
    "#<#{shape_str(with_id: true)}>\n#{dataframe_info(10)}"
  when 'TDRA'
    "#<#{shape_str(with_id: true)}>\n#{dataframe_info(:all)}"
  when 'MINIMUM'
    shape_str
  when 'PLAIN'
    "#<#{shape_str}>\n#{to_s(width: 128, head: 128)}"
  else
    "#<#{shape_str(with_id: true)}>\n#{to_s(width: 100, head: 20)}"
  end
end

#shape_str(with_id: false) ⇒ String

Return class and shape of self by a String.

Examples:

Default (without id)

penguins.shape_str

# =>
"RedAmber::DataFrame : 344 x 8 Vectors"

With id

penguins.shape_str(with_id: true)

# =>
"RedAmber::DataFrame : 344 x 8 Vectors, 0x0000000000003980"

Parameters:

  • with_id (true, false) (defaults to: false) —

    show id if true.

Returns:

  • (String) —

    shape string.



342
343
344
345
346
 
# File 'lib/red_amber/data_frame_displayable.rb', line 342

def shape_str(with_id: false)
  shape_info = empty? ? '(empty)' : "#{size} x #{n_keys} Vector#{pl(n_keys)}"
  id = with_id ? format(', 0x%016x', object_id) : ''
  "#{self.class} : #{shape_info}#{id}"
end

#summary ⇒ DataFrame Also known as: describe

Show statistical summary by a new DataFrame.

This method will make stats only for numeric columns.

  • NaNs are ignored.

  • ‘count` shows non-NaN counts.

Examples:

Statistical summary of penguins dataset

puts penguins.summary.to_s

# =>
  variables            count     mean      std      min      25%   median      75%      max
  <dictionary>      <uint16> <double> <double> <double> <double> <double> <double> <double>
0 bill_length_mm         342    43.92     5.46     32.1    39.23    44.38     48.5     59.6
1 bill_depth_mm          342    17.15     1.97     13.1     15.6    17.32     18.7     21.5
2 flipper_length_mm      342   200.92    14.06    172.0    190.0    197.0    213.0    231.0
3 body_mass_g            342  4201.75   801.95   2700.0   3550.0   4031.5   4750.0   6300.0
4 year                   344  2008.03     0.82   2007.0   2007.0   2008.0   2009.0   2009.0

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/red_amber/data_frame_displayable.rb', line 70

def summary
  num_keys = keys.select { |key| self[key].numeric? }

  DataFrame.new(
    variables: num_keys,
    count: num_keys.map { |k| self[k].count },
    mean: num_keys.map { |k| self[k].mean },
    std: num_keys.map { |k| self[k].std },
    min: num_keys.map { |k| self[k].min },
    '25%': num_keys.map { |k| self[k].quantile(0.25) },
    median: num_keys.map { |k| self[k].median },
    '75%': num_keys.map { |k| self[k].quantile(0.75) },
    max: num_keys.map { |k| self[k].max }
  )
end

#tdr(limit = 10, tally: 5, elements: 5) ⇒ nil Also known as: glimpse

Shows some information about self in a transposed style.

Examples:

Default

diamonds = diamonds.assign_left(:index) { indices }
diamonds

# =>
#<RedAmber::DataFrame : 53940 x 11 Vectors, 0x0000000000035084>
         index    carat cut       color    clarity     depth    table    price        x        y        z
      <uint16> <double> <string>  <string> <string> <double> <double> <uint16> <double> <double> <double>
    0        0     0.23 Ideal     E        SI2          61.5     55.0      326     3.95     3.98     2.43
    1        1     0.21 Premium   E        SI1          59.8     61.0      326     3.89     3.84     2.31
    2        2     0.23 Good      E        VS1          56.9     65.0      327     4.05     4.07     2.31
    3        3     0.29 Premium   I        VS2          62.4     58.0      334      4.2     4.23     2.63
    4        4     0.31 Good      J        SI2          63.3     58.0      335     4.34     4.35     2.75
    5        5     0.24 Very Good J        VVS2         62.8     57.0      336     3.94     3.96     2.48
    6        6     0.24 Very Good I        VVS1         62.3     57.0      336     3.95     3.98     2.47
    7        7     0.26 Very Good H        SI1          61.9     55.0      337     4.07     4.11     2.53
    8        8     0.22 Fair      E        VS2          65.1     61.0      337     3.87     3.78     2.49
    9        9     0.23 Very Good H        VS1          59.4     61.0      338      4.0     4.05     2.39
   10       10      0.3 Good      J        SI1          64.0     55.0      339     4.25     4.28     2.73
   11       11     0.23 Ideal     J        VS1          62.8     56.0      340     3.93      3.9     2.46
   12       12     0.22 Premium   F        SI1          60.4     61.0      342     3.88     3.84     2.33
   13       13     0.31 Ideal     J        SI2          62.2     54.0      344     4.35     4.37     2.71
   14       14      0.2 Premium   E        SI2          60.2     62.0      345     3.79     3.75     2.27
   15       15     0.32 Premium   E        I1           60.9     58.0      345     4.38     4.42     2.68
   16       16      0.3 Ideal     I        SI2          62.0     54.0      348     4.31     4.34     2.68
   17       17      0.3 Good      J        SI1          63.4     54.0      351     4.23     4.29      2.7
   18       18      0.3 Good      J        SI1          63.8     56.0      351     4.23     4.26     2.71
   19       19      0.3 Very Good J        SI1          62.7     59.0      351     4.21     4.27     2.66
    :        :        : :         :        :               :        :        :        :        :        :
53936    53936     0.72 Good      D        SI1          63.1     55.0     2757     5.69     5.75     3.61
53937    53937      0.7 Very Good D        SI1          62.8     60.0     2757     5.66     5.68     3.56
53938    53938     0.86 Premium   H        SI2          61.0     58.0     2757     6.15     6.12     3.74
53939    53939     0.75 Ideal     D        SI2          62.2     55.0     2757     5.83     5.87     3.64

diamonds.tdr

# =>
RedAmber::DataFrame : 53940 x 11 Vectors
Vectors : 8 numeric, 3 strings
#  key      type   level data_preview
0  :index   uint16 53940 [0, 1, 2, 3, 4, ... ]
1  :carat   double   273 [0.23, 0.21, 0.23, 0.29, 0.31, ... ]
2  :cut     string     5 {"Ideal"=>21551, "Premium"=>13791, "Good"=>4906, "Very Good"=>12082, "Fair"=>1610}
3  :color   string     7 ["E", "E", "E", "I", "J", ... ]
4  :clarity string     8 ["SI2", "SI1", "VS1", "VS2", "SI2", ... ]
5  :depth   double   184 [61.5, 59.8, 56.9, 62.4, 63.3, ... ]
6  :table   double   127 [55.0, 61.0, 65.0, 58.0, 58.0, ... ]
7  :price   uint16 11602 [326, 326, 327, 334, 335, ... ]
8  :x       double   554 [3.95, 3.89, 4.05, 4.2, 4.34, ... ]
9  :y       double   552 [3.98, 3.84, 4.07, 4.23, 4.35, ... ]
 ... 1 more Vector ...

Show all variables

diamonds.tdr(:all)

# =>
RedAmber::DataFrame : 53940 x 11 Vectors
Vectors : 8 numeric, 3 strings
#  key      type   level data_preview
0  :index   uint16 53940 [0, 1, 2, 3, 4, ... ]
1  :carat   double   273 [0.23, 0.21, 0.23, 0.29, 0.31, ... ]
2  :cut     string     5 {"Ideal"=>21551, "Premium"=>13791, "Good"=>4906, "Very Good"=>12082, "Fair"=>1610}
3  :color   string     7 ["E", "E", "E", "I", "J", ... ]
4  :clarity string     8 ["SI2", "SI1", "VS1", "VS2", "SI2", ... ]
5  :depth   double   184 [61.5, 59.8, 56.9, 62.4, 63.3, ... ]
6  :table   double   127 [55.0, 61.0, 65.0, 58.0, 58.0, ... ]
7  :price   uint16 11602 [326, 326, 327, 334, 335, ... ]
8  :x       double   554 [3.95, 3.89, 4.05, 4.2, 4.34, ... ]
9  :y       double   552 [3.98, 3.84, 4.07, 4.23, 4.35, ... ]
10 :z       double   375 [2.43, 2.31, 2.31, 2.63, 2.75, ... ]

Use tally mode up to 8 levels

diamonds.tdr(tally: 8)

# =>
RedAmber::DataFrame : 53940 x 11 Vectors
Vectors : 8 numeric, 3 strings
#  key      type   level data_preview
0  :index   uint16 53940 [0, 1, 2, 3, 4, ... ]
1  :carat   double   273 [0.23, 0.21, 0.23, 0.29, 0.31, ... ]
2  :cut     string     5 {"Ideal"=>21551, "Premium"=>13791, "Good"=>4906, "Very Good"=>12082, "Fair"=>1610}
3  :color   string     7 {"E"=>9797, "I"=>5422, "J"=>2808, "H"=>8304, "F"=>9542, "G"=>11292, "D"=>6775}
4  :clarity string     8 {"SI2"=>9194, "SI1"=>13065, "VS1"=>8171, "VS2"=>12258, "VVS2"=>5066, "VVS1"=>3655, "I1"=>741, "IF"=>1790}
5  :depth   double   184 [61.5, 59.8, 56.9, 62.4, 63.3, ... ]
6  :table   double   127 [55.0, 61.0, 65.0, 58.0, 58.0, ... ]
7  :price   uint16 11602 [326, 326, 327, 334, 335, ... ]
8  :x       double   554 [3.95, 3.89, 4.05, 4.2, 4.34, ... ]
9  :y       double   552 [3.98, 3.84, 4.07, 4.23, 4.35, ... ]
 ... 1 more Vector ...

Increase elements to show

diamonds.tdr(elements: 10)

# =>
RedAmber::DataFrame : 53940 x 11 Vectors
Vectors : 8 numeric, 3 strings
#  key      type   level data_preview
0  :index   uint16 53940 [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, ... ]
1  :carat   double   273 [0.23, 0.21, 0.23, 0.29, 0.31, 0.24, 0.24, 0.26, 0.22, 0.23, ... ]
2  :cut     string     5 {"Ideal"=>21551, "Premium"=>13791, "Good"=>4906, "Very Good"=>12082, "Fair"=>1610}
3  :color   string     7 ["E", "E", "E", "I", "J", "J", "I", "H", "E", "H", ... ]
4  :clarity string     8 ["SI2", "SI1", "VS1", "VS2", "SI2", "VVS2", "VVS1", "SI1", "VS2", "VS1", ... ]
5  :depth   double   184 [61.5, 59.8, 56.9, 62.4, 63.3, 62.8, 62.3, 61.9, 65.1, 59.4, ... ]
6  :table   double   127 [55.0, 61.0, 65.0, 58.0, 58.0, 57.0, 57.0, 55.0, 61.0, 61.0, ... ]
7  :price   uint16 11602 [326, 326, 327, 334, 335, 336, 336, 337, 337, 338, ... ]
8  :x       double   554 [3.95, 3.89, 4.05, 4.2, 4.34, 3.94, 3.95, 4.07, 3.87, 4.0, ... ]
9  :y       double   552 [3.98, 3.84, 4.07, 4.23, 4.35, 3.96, 3.98, 4.11, 3.78, 4.05, ... ]
 ... 1 more Vector ...

Parameters:

  • limit (Integer, :all) (defaults to: 10) —

    maximum number of variables (columns) to show. Shows all valiables (columns) if it is ‘:all`.

  • tally (Integer) (defaults to: 5) —

    maximum level to use tally mode. Tally mode counts the occurrences of each element and shows as a hash with the elements as keys and the corresponding counts as values.

  • elements (Integer) (defaults to: 5) —

    maximum number of elements to show values in each column.

Returns:

  • (nil) 


267
268
269
 
# File 'lib/red_amber/data_frame_displayable.rb', line 267

def tdr(limit = 10, tally: 5, elements: 5)
  puts tdr_str(limit, tally: tally, elements: elements)
end

#tdr_str(limit = 10, tally: 5, elements: 5) ⇒ String

Returns some information about self in a transposed style by a string.

Parameters:

  • limit (Integer, :all) (defaults to: 10) —

    maximum number of variables (columns) to show. Shows all valiables (columns) if it is ‘:all`.

  • tally (Integer) (defaults to: 5) —

    maximum level to use tally mode. Tally mode counts the occurrences of each element and shows as a hash with the elements as keys and the corresponding counts as values.

  • elements (Integer) (defaults to: 5) —

    maximum number of elements to show values in each column.

Returns:

  • (String) —

    TDR style string.



289
290
291
 
# File 'lib/red_amber/data_frame_displayable.rb', line 289

def tdr_str(limit = 10, tally: 5, elements: 5)
  "#{shape_str}\n#{dataframe_info(limit, tally_level: tally, max_element: elements)}"
end

#tdra(tally: 5, elements: 5) ⇒ nil

Shortcut for ‘tdr(:all)`.

Parameters:

  • limit (Integer, :all) —

    maximum number of variables (columns) to show. Shows all valiables (columns) if it is ‘:all`.

  • tally (Integer) (defaults to: 5) —

    maximum level to use tally mode. Tally mode counts the occurrences of each element and shows as a hash with the elements as keys and the corresponding counts as values.

  • elements (Integer) (defaults to: 5) —

    maximum number of elements to show values in each column.

Returns:

  • (nil) 


277
278
279
 
# File 'lib/red_amber/data_frame_displayable.rb', line 277

def tdra(tally: 5, elements: 5)
  puts tdr_str(:all, tally: tally, elements: elements)
end

#to_iruby ⇒ String

Returns html formatted text of self by IRuby::HTML.table.

According to ‘ENV [“RED_AMBER_OUTPUT_MODE”].upcase`,

  • If it is ‘MINIMUM’, returns shape by plain text.

  • If it is ‘PLAIN’, returns ‘#inspect` value by plain text.

  • If it is ‘TDR’, returns shape and transposed preview by plain text.

  • If it is ‘TDRA’, returns shape and transposed preview by plain text.

  • If it is ‘TABLE’ or otherwise, returns Table preview by html format. Default value of the ENV is ‘TABLE’.

Returns:

  • (String) —

    formatted string.



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/red_amber/data_frame_displayable.rb', line 305

def to_iruby
  require 'iruby'
  return ['text/plain', '(empty DataFrame)'] if empty?

  mode = ENV.fetch('RED_AMBER_OUTPUT_MODE', 'Table')
  case mode.upcase
  when 'PLAIN'
    ['text/plain', inspect]
  when 'MINIMUM'
    ['text/plain', shape_str]
  when 'TDR'
    size <= 5 ? ['text/plain', tdr_str(tally: 0)] : ['text/plain', tdr_str]
  when 'TDRA'
    ['text/plain', tdr_str(:all)]
  else # 'TABLE'
    ['text/html', html_table]
  end
end

#to_s(width: 90, head: 5, tail: 4) ⇒ String

Show a preview of self as a string.

Examples:

Show penguins dataset

puts penguins.to_s

# =>
    species  island    bill_length_mm bill_depth_mm flipper_length_mm body_mass_g ...     year
    <string> <string>        <double>      <double>           <uint8>    <uint16> ... <uint16>
  0 Adelie   Torgersen           39.1          18.7               181        3750 ...     2007
  1 Adelie   Torgersen           39.5          17.4               186        3800 ...     2007
  2 Adelie   Torgersen           40.3          18.0               195        3250 ...     2007
  3 Adelie   Torgersen          (nil)         (nil)             (nil)       (nil) ...     2007
  4 Adelie   Torgersen           36.7          19.3               193        3450 ...     2007
  : :        :                      :             :                 :           : ...        :
340 Gentoo   Biscoe              46.8          14.3               215        4850 ...     2009
341 Gentoo   Biscoe              50.4          15.7               222        5750 ...     2009
342 Gentoo   Biscoe              45.2          14.8               212        5200 ...     2009
343 Gentoo   Biscoe              49.9          16.1               213        5400 ...     2009

Parameters:

  • width (Integer) (defaults to: 90) —

    maximum size of result.

  • head (Integer) (defaults to: 5) —

    number of records to show from head.

  • tail (Integer) (defaults to: 4) —

    number of records to show at tail.

Returns:

  • (String) —

    string representation of self.



44
45
46
47
48
 
# File 'lib/red_amber/data_frame_displayable.rb', line 44

def to_s(width: 90, head: 5, tail: 4)
  return '' if empty?

  format_table(width: width, head: head, tail: tail)
end