jupyter-ijavascript-utils 1.1.0 → 1.2.0

package/DOCS.md

@@ -22,6 +22,12 @@ See the [#Installation section for requirements and installation](#install)
 
 -------
 
+## What's New
+
+5.2 - bumped vega-lite to latest
+
+-------
+
 # For Example
 
 ## Get Sample Data

package/README.md

@@ -16,6 +16,10 @@ Simple library for working with Jupyter - through IJavaScript kernel.
 
 See documentation at: [https://jupyter-ijavascript-utils.onrender.com/](https://jupyter-ijavascript-utils.onrender.com/)
 
+# What's New
+
+5.2 - bumped vega-lite to latest
+
 # For Example
 
 ## Get Sample Data

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jupyter-ijavascript-utils",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Utilities for working with iJavaScript - a Jupyter Kernel",
   "main": "src/index.js",
   "scripts": {
@@ -45,9 +45,9 @@
     "pino-pretty": "^5.1.2",
     "plantuml-encoder": "^1.4.0",
     "promise-sequential": "^1.1.1",
-    "vega": "^5.20.2",
-    "vega-datasets": "^2.2.0",
-    "vega-lite": "^5.1.0",
+    "vega": "^5.22.0",
+    "vega-datasets": "^2.3.0",
+    "vega-lite": "^5.2.0",
     "vega-lite-api": "^5.0.0"
   }
 }

package/tutorials/exampleWalkthrough.markdown

@@ -113,22 +113,22 @@ We can see the list of the datasets available:
 ```
 utils.datasets.list();
 
-[
-  'annual-precip.json',
-  'anscombe.json',
-  'barley.json',
-  'budget.json',
-  'budgets.json',
-  'burtin.json',
-  ...
-]
+// [
+//   'annual-precip.json',
+//   'anscombe.json',
+//   'barley.json',
+//   'budget.json',
+//   'budgets.json',
+//   'burtin.json',
+//   ...
+// ]
 ```
 
 The DataSet we want is the [facinating GapMinder Life Expectancy study](https://www.gapminder.org/answers/how-does-income-relate-to-life-expectancy/)
 
 ```
 $$.async()
-utils.datasets.load('gapminder.json')
+utils.datasets.fetch('gapminder.json')
 .then(data => {
 	gapMinder = data;
 	$$.sendResult(gapMinder);
@@ -141,7 +141,7 @@ As we called `$$.async()` - the cell knows that it should pause execution for th
 
 ```
 utils.ijs.await(async ($$, console) => {
-	gapMinder = await utils.datasets.load('gapminder.json');
+	gapMinder = await utils.datasets.fetch('gapminder.json');
 });
 ```
 
@@ -154,15 +154,15 @@ One option to understand the kinds of data is to always look at the first record
 ```
 gapMinder[0];
 
-gives:
-{
-  year: 1955,
-  country: 'Afghanistan',
-  cluster: 0,
-  pop: 8891209,
-  life_expect: 30.332,
-  fertility: 7.7
-}
+// gives:
+// {
+//   year: 1955,
+//   country: 'Afghanistan',
+//   cluster: 0,
+//   pop: 8891209,
+//   life_expect: 30.332,
+//   fertility: 7.7
+// }
 ```
 
 The Utilities also include two additional methods that can help:
@@ -177,22 +177,22 @@ It tells us that there are no objects further down with additional fields, and a
 But this can leave a bit to be desired for the types of properties.
 
 ```
-{
-  '$schema': 'http://json-schema.org/draft-04/schema#',
-  type: 'array',
-  items: {
-    type: 'object',
-    properties: {
-      year: [Object],
-      country: [Object],
-      cluster: [Object],
-      pop: [Object],
-      life_expect: [Object],
-      fertility: [Object]
-    },
-    required: [ 'year', 'country', 'cluster', 'pop', 'life_expect', 'fertility' ]
-  }
-}
+// {
+//   '$schema': 'http://json-schema.org/draft-04/schema#',
+//   type: 'array',
+//   items: {
+//     type: 'object',
+//     properties: {
+//       year: [Object],
+//       country: [Object],
+//       cluster: [Object],
+//       pop: [Object],
+//       life_expect: [Object],
+//       fertility: [Object]
+//     },
+//     required: [ 'year', 'country', 'cluster', 'pop', 'life_expect', 'fertility' ]
+//   }
+// }
 ```
 
 {@link module:object.getObjectPropertyTypes|object.getObjectPropertyTypes(object / array)}
@@ -203,11 +203,11 @@ but only of the objects in the collection (shallow introspection).
 ```
 utils.object.getObjectPropertyTypes(gapMinder)
 
-returns
-Map(2) {
-  'number' => Set(5) { 'year', 'cluster', 'pop', 'life_expect', 'fertility' },
-  'string' => Set(1) { 'country' }
-}
+// returns
+// Map(2) {
+//   'number' => Set(5) { 'year', 'cluster', 'pop', 'life_expect','fertility' },
+//   'string' => Set(1) { 'country' }
+// }
 ```
 
 # Simple Aggregation
@@ -232,11 +232,11 @@ or which countries are covered:
 
 ```
 utils.aggregate.unique(gapMinder, 'country')
-[
-  'Afghanistan', 'Argentina', 'Aruba',
-  'Australia', 'Austria', 'Bahamas',
-  ...
-]
+// [
+//   'Afghanistan', 'Argentina', 'Aruba',
+//   'Australia', 'Austria', 'Bahamas',
+//   ...
+// ]
 ```
 
 how many countries:
@@ -256,15 +256,15 @@ Or maybe I would like to know the extents for multiple fields:
   year_range: utils.agg.extent(gapMinder, 'year'),
   pop_range: utils.agg.extent(gapMinder, 'pop'),
   life_expect: utils.agg.extent(gapMinder, 'life_expect'),
-  fertility: utils.agg.uniextentque(gapMinder, 'fertility')
+  fertility: utils.agg.extent(gapMinder, 'fertility')
 });
-returns
-{
-  year_range: { min: 1955, max: 2005 },
-  pop_range: { min: 53865, max: 1303182268 },
-  life_expect: { min: 23.599, max: 82.603 },
-  fertility: { min: 0.94, max: 8.5 }
-}
+// returns
+// {
+//   year_range: { min: 1955, max: 2005 },
+//   pop_range: { min: 53865, max: 1303182268 },
+//   life_expect: { min: 23.599, max: 82.603 },
+//   fertility: { min: 0.94, max: 8.5 }
+// }
 ```
 
 # Group Transformations
@@ -285,29 +285,29 @@ utils.group.by(gapMinder, 'cluster')
 it looks like they are geography regions:
 
 ```
-[
-  {
-    cluster: 0,
-    countries: [ 'Afghanistan', 'Bangladesh', 'India', 'Pakistan' ]
-  },
-  {
-    cluster: 3,
-    countries: [
-      'Argentina', 'Aruba', 'Bahamas',   'Barbados', 'Bolivia',
-      'Brazil', 'Canada',    'Chile', 'Colombia',  'Costa Rica',
-      'Cuba',      'Dominican Republic', 'Ecuador',   'El Salvador',
-      'Grenada',   'Haiti', 'Jamaica',   'Mexico', 'Peru',     'United States', 'Venezuela'
-    ]
-  },
-  {
-    cluster: 4,
-    countries: [
-      'Australia', 'China', 'Hong Kong', 'Indonesia', 'Japan',
-      'South Korea', 'North Korea', 'New Zealand', 'Philippines'
-    ]
-  },
-  ...
-]
+// [
+//   {
+//     cluster: 0,
+//     countries: [ 'Afghanistan', 'Bangladesh', 'India', 'Pakistan' ]
+//   },
+//   {
+//     cluster: 3,
+//     countries: [
+//       'Argentina', 'Aruba', 'Bahamas',   'Barbados', 'Bolivia',
+//       'Brazil', 'Canada',    'Chile', 'Colombia',  'Costa Rica',
+//       'Cuba',      'Dominican Republic', 'Ecuador',   'El Salvador',
+//       'Grenada',   'Haiti', 'Jamaica',   'Mexico', 'Peru',     'United States', 'Venezuela'
+//     ]
+//   },
+//   {
+//     cluster: 4,
+//     countries: [
+//       'Australia', 'China', 'Hong Kong', 'Indonesia', 'Japan',
+//       'South Korea', 'North Korea', 'New Zealand', 'Philippines'
+//     ]
+//   },
+//   ...
+// ]
 ```
 
 How many entries are there per country?
@@ -323,14 +323,14 @@ utils.group.by(gapMinder, 'country')
     .sort(utils.array.createSort('-count'));
 
 // provides
-[
-  { country: 'Afghanistan', count: 11 },
-  { country: 'Argentina', count: 11 },
-  { country: 'Aruba', count: 11 },
-  { country: 'Australia', count: 11 },
-  { country: 'Austria', count: 11 },
-  ...
-]
+// [
+//   { country: 'Afghanistan', count: 11 },
+//   { country: 'Argentina', count: 11 },
+//   { country: 'Aruba', count: 11 },
+//   { country: 'Australia', count: 11 },
+//   { country: 'Austria', count: 11 },
+//   ...
+// ]
 ```
 
 Looks like they are 11 records all the way down.
@@ -365,29 +365,29 @@ utils.group.by(gapMinder, 'country', 'year')
     .get('Afghanistan');
 
 //-- returns
-SourceMap(11) [Map] {
-  1955 => [
-    {
-      year: 1955,
-      country: 'Afghanistan',
-      cluster: 0,
-      pop: 8891209,
-      life_expect: 30.332,
-      fertility: 7.7
-    }
-  ],
-  1960 => [
-    {
-      year: 1960,
-      country: 'Afghanistan',
-      cluster: 0,
-      pop: 9829450,
-      life_expect: 31.997,
-      fertility: 7.7
-    }
-  ],
-  ...
-}
+// SourceMap(11) [Map] {
+//   1955 => [
+//     {
+//       year: 1955,
+//       country: 'Afghanistan',
+//       cluster: 0,
+//       pop: 8891209,
+//       life_expect: 30.332,
+//       fertility: 7.7
+//     }
+//   ],
+//   1960 => [
+//     {
+//       year: 1960,
+//       country: 'Afghanistan',
+//       cluster: 0,
+//       pop: 9829450,
+//       life_expect: 31.997,
+//       fertility: 7.7
+//     }
+//   ],
+//   ...
+// }
 ```
 
 # Table