red_amber 0.4.0 → 0.4.2

data/docker/notebook/red-amber.ipynb

@@ -0,0 +1,188 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# RedAmber Examples\n",
+    "\n",
+    "This notebook walks through the [README of RedAmber](https://github.com/heronshoes/red_amber#readme)."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## `RedAmber::DataFrame`"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "require 'red_amber'\n",
+    "include RedAmber\n",
+    "require 'datasets-arrow'\n",
+    "\n",
+    "{RedAmber: VERSION, Datasets: Datasets::VERSION}"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Example: diamonds dataset\n",
+    "\n",
+    "For the first loading of Datasets::Diamonds, it will take some time to download."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "dataset = Datasets::Diamonds.new\n",
+    "diamonds = DataFrame.new(dataset)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "df = diamonds\n",
+    "  .slice { carat > 1 } # or use #filter instead of #slice\n",
+    "  .group(:cut)\n",
+    "  .mean(:price) # `pick` prior to `group` is not required if `:price` is specified here.\n",
+    "  .sort('-mean(price)')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "usdjpy = 110.0 # when the yen was stronger\n",
+    "\n",
+    "df.rename('mean(price)': :mean_price_USD)\n",
+    "  .assign(:mean_price_JPY) { mean_price_USD * usdjpy }"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "tags": []
+   },
+   "source": [
+    "## Example: starwars dataset"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "uri = URI('https://vincentarelbundock.github.io/Rdatasets/csv/dplyr/starwars.csv')\n",
+    "\n",
+    "starwars = DataFrame.load(uri)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "starwars\n",
+    "  .drop(0) # delete unnecessary index column\n",
+    "  .remove { species == \"NA\" } # delete unnecessary rows\n",
+    "  .group(:species) { [count(:species), mean(:height, :mass)] }\n",
+    "  .slice { count > 1 } # or use #filter instead of slice"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## `RedAmber::Vector`"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "penguins = DataFrame.new(Datasets::Penguins.new)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "penguins[:bill_length_mm]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "penguins[:bill_length_mm] < 40"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "penguins[:bill_length_mm].mean"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Ruby 3.0.2",
+   "language": "ruby",
+   "name": "ruby"
+  },
+  "language_info": {
+   "file_extension": ".rb",
+   "mimetype": "application/x-ruby",
+   "name": "ruby",
+   "version": "3.0.2"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

data/docker/readme.md

@@ -0,0 +1,118 @@
+# RedAmber Minimal Notebook
+
+This is a docker image containing RedAmber created from 
+[jupyter/minimal-notebook](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html#jupyter-minimal-notebook)
+
+## Contents
+
+- From jupyter/minimal-notebook:
+  - Based on 2023-03-13 (295612d3ade4)
+  - x86-64
+  - Ubuntu-22.04
+  - python-3.10.9
+  - lab-3.6.1
+  - notebook-6.5.3
+- System ruby-dev:
+  - Ruby 3.0.2
+- Arrow 11.0.0 for Ubuntu:
+  - libarrow-dev
+  - libarrow-glib-dev
+  - libparquet-dev
+  - libparquet-glib-dev
+- Locally installed iruby:
+  - Using Ruby 3.0.2
+- Locally installed bundler and Gemfile:
+  - RedAmber 0.4.1
+  - Others (see Gemfile)
+
+## Install
+
+```
+git clone https://github.com/heronshoes/red_amber.git
+cd  docker
+```
+
+Edit ENV variable in `.env` as you like.
+
+[note] NB_USER is fixed for `jovyan`, the common user name in Jupyter,
+can not change it in this version.
+
+If TZ is not used in your host system, define it here.
+Otherwise UTC is used in the container.
+
+TOKEN will be used for token-based authentication.
+
+```
+# Example
+TZ=Asia/Tokyo
+TOKEN='something'
+```
+
+Then build `red_amber-minimal-notebook` container. It will take a while.
+
+```
+docker-compose build
+```
+
+## Start Jupyter Lab
+
+After build, start the container. Adding `-d` option will detach it in background.
+
+```
+docker-compose up
+```
+
+You can access Jupyter Lab from `http://localhost:8888/` in your browser.
+
+- `red-amber.ipynb`:
+  - Walks through the [README of RedAmber](https://github.com/heronshoes/red_amber#readme).
+- `examples_of_red_amber.ipynb`:
+  - [Examples of RedAmber](https://github.com/heronshoes/red_amber/blob/main/docker/notebook/examples_of_red_amber.ipynb) in Notebook style.
+
+## Example in REPL
+
+You can try RedAmber in irb with pre-loaded datasets.
+
+Start `terminal` in Jupyter.
+
+For the first run,
+
+```
+source ~/.bashrc
+../example
+
+```
+
+It will take a while for the first run to fetch and prepare red-datasets cache.
+
+If irb starts you can see:
+
+```ruby
+
+    69: # Welcome to RedAmber example!
+    70: # This environment will offer these pre-loaded datasets:
+    71: #   penguins, diamonds, iris, starwars, simpsons_paradox_covid,
+    72: #   mtcars, band_members, band_instruments, band_instruments2
+    73: #   (original) import_cars, comecome, dataframe, subframes
+ => 74: binding.irb
+
+irb(main):001:0> 
+```
+
+RedAmber is already loaded in this environment with some datasets shown above.
+
+```ruby
+irb(main):002:0> dataframe
+=> 
+#<RedAmber::DataFrame : 6 x 3 Vectors, 0x0000000000003818>
+        x y        z
+  <uint8> <string> <boolean>
+0       1 A        false
+1       2 A        true
+2       3 B        false
+3       4 B        (nil)
+4       5 B        true
+5       6 C        false
+```
+
+Next time you start this environment, you can simply invoke as `../example`.

data/lib/red_amber/data_frame.rb

@@ -33,6 +33,23 @@ module RedAmber
         instance.instance_variable_set(:@table, table)
         instance
       end
+
+      # Return new DataFrame for specified schema and value.
+      #
+      # @param dataframe_for_schema [Dataframe]
+      #   schema of this dataframe will be used.
+      # @param dataframe_for_value [DataFrame]
+      #   column values of thes dataframe will be used.
+      # @return [DataFrame]
+      #   created DataFrame.
+      # @since 0.4.1
+      #
+      def new_dataframe_with_schema(dataframe_for_schema, dataframe_for_value)
+        DataFrame.create(
+          Arrow::Table.new(dataframe_for_schema.table.schema,
+                           dataframe_for_value.table.columns)
+        )
+      end
     end
 
     # Creates a new DataFrame.
@@ -194,7 +211,7 @@ module RedAmber
     #   `key => Vector` pairs for each columns.
     #
     def variables
-      @variables || @variables = init_instance_vars(:variables)
+      @variables ||= init_instance_vars(:variables)
     end
     alias_method :vars, :variables
 
@@ -204,7 +221,7 @@ module RedAmber
     #   keys in an Array.
     #
     def keys
-      @keys || @keys = init_instance_vars(:keys)
+      @keys ||= init_instance_vars(:keys)
     end
     alias_method :column_names, :keys
     alias_method :var_names, :keys
@@ -240,7 +257,7 @@ module RedAmber
     #   abbreviated Red Arrow data type names.
     #
     def types
-      @types || @types = @table.columns.map do |column|
+      @types ||= @table.columns.map do |column|
         column.data.value_type.nick.to_sym
       end
     end
@@ -251,7 +268,7 @@ module RedAmber
     #   an Array of Red Arrow data type Classes.
     #
     def type_classes
-      @data_types || @data_types = @table.columns.map { |column| column.data_type.class }
+      @type_classes ||= @table.columns.map { |column| column.data_type.class }
     end
 
     # Returns Vectors in an Array.
@@ -260,7 +277,7 @@ module RedAmber
     #   an Array of Vector.
     #
     def vectors
-      @vectors || @vectors = init_instance_vars(:vectors)
+      @vectors ||= init_instance_vars(:vectors)
     end
 
     # Returns column-oriented data in a Hash.
@@ -682,7 +699,7 @@ module RedAmber
 
     # Catch variable (column) key as method name.
     def method_missing(name, *args, &block)
-      return v(name) if args.empty? && key?(name)
+      return variables[name] if args.empty? && key?(name)
 
       super
     end
@@ -723,11 +740,9 @@ module RedAmber
     end
 
     def name_unnamed_keys
-      return unless @table.key?('')
+      return unless @table.key?(:'')
 
-      # We can't use #keys because it causes mismatch of @table and @keys
-      keys = @table.schema.fields.map { |f| f.name.to_sym }
-      unnamed = (:unnamed1..).find { |e| !keys.include?(e) }
+      unnamed = (:unnamed1..).find { |name| !@table.key?(name) }
       fields =
         @table.schema.fields.map do |field|
           if field.name.empty?