@nshiab/simple-data-analysis 5.19.10 → 5.19.12

package/script/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/helpers/prepChart.js

@@ -0,0 +1,162 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = prepChart;
+const d3_array_1 = require("d3-array");
+const getColors_js_1 = __importDefault(require("./getColors.js"));
+const drawChart_js_1 = __importDefault(require("./drawChart.js"));
+const validateDataTypes_js_1 = __importDefault(require("./validateDataTypes.js"));
+const index_js_1 = require("../../../../../journalism-format/1.1.9/src/index.js");
+function prepChart(type, data, x, y, drawFunction, options = {}) {
+    (0, validateDataTypes_js_1.default)(data, x, y);
+    const formatX = options.formatX
+        ? options.formatX
+        : data[0][x] instanceof Date
+            ? (d) => (0, index_js_1.formatDate)(d, "YYYY-MM-DD", { utc: true })
+            : function (d) {
+                return String(d);
+            };
+    const formatY = options.formatY
+        ? options.formatY
+        : (d) => (0, index_js_1.formatNumber)(d);
+    const width = options.width ?? 75;
+    const height = options.height ?? 15;
+    const smallMultiplesPerRow = options.smallMultiplesPerRow ?? 2;
+    const smallMultiples = options.smallMultiples ?? null;
+    const fixedScales = options.fixedScales ?? false;
+    if (typeof smallMultiples === "string") {
+        const categories = Array.from(new Set(data.map((d) => d[smallMultiples])));
+        const colors = (0, getColors_js_1.default)(categories);
+        const allLabelsX = [];
+        let xMin;
+        let xMax;
+        let yMin;
+        let yMax;
+        // min and max values for the whole data
+        if (fixedScales) {
+            const xValues = data.map((d) => {
+                const val = d[x];
+                return val instanceof Date ? val.getTime() : val;
+            });
+            xMin = (0, d3_array_1.min)(xValues);
+            xMax = (0, d3_array_1.max)(xValues);
+            const yValues = data.map((d) => d[y]);
+            yMin = (0, d3_array_1.min)(yValues);
+            yMax = (0, d3_array_1.max)(yValues);
+            if (xMin === undefined ||
+                xMax === undefined ||
+                yMin === undefined ||
+                yMax === undefined) {
+                throw new Error("The min or max value is undefined.");
+            }
+        }
+        if (data.length > Math.round(width / smallMultiplesPerRow)) {
+            if (type === "line") {
+                console.log("\x1b[2m\n/!\\ Number of values greater than width. Averaged values displayed.\x1b[0m");
+            }
+            else if (type === "dot") {
+                console.log("\x1b[2m\n/!\\ Number of values greater than width. Dots might overlap.\x1b[0m");
+            }
+        }
+        const allCharts = colors?.map((c) => {
+            const dataFiltered = data.filter((d) => d[smallMultiples] === c.category);
+            // The min and max values for each small multiple
+            if (!fixedScales) {
+                const xValues = dataFiltered.map((d) => {
+                    const val = d[x];
+                    return val instanceof Date ? val.getTime() : val;
+                });
+                xMin = (0, d3_array_1.min)(xValues);
+                xMax = (0, d3_array_1.max)(xValues);
+                const yValues = dataFiltered.map((d) => d[y]);
+                yMin = (0, d3_array_1.min)(yValues);
+                yMax = (0, d3_array_1.max)(yValues);
+            }
+            const { chart, xLabels } = (0, drawChart_js_1.default)(type, drawFunction, dataFiltered, x, y, c.color, {
+                title: c.category,
+                width: Math.round(width / smallMultiplesPerRow),
+                height: height,
+                formatX: formatX,
+                formatY: formatY,
+                xMin,
+                xMax,
+                yMin,
+                yMax,
+            });
+            allLabelsX.push(...xLabels);
+            return chart;
+        });
+        if (allCharts === undefined) {
+            throw new Error("No data to display.");
+        }
+        // Restructure the charts to make small multiples on multiple columns
+        const allChartsRows = [];
+        for (let i = 0; i < allCharts.length; i += smallMultiplesPerRow) {
+            const charts = allCharts.slice(i, i + smallMultiplesPerRow);
+            const combinedRows = [];
+            for (let j = 0; j < charts.length; j++) {
+                if (j === 0) {
+                    combinedRows.push(...charts[j]);
+                }
+                else {
+                    for (let k = 0; k < charts[j].length; k++) {
+                        combinedRows[k].push(" ".repeat(3), ...charts[j][k]);
+                    }
+                }
+            }
+            allChartsRows.push(...combinedRows);
+            allChartsRows.push(" ".repeat(combinedRows[0].length).split(""));
+        }
+        let chartString = allChartsRows.map((d) => d.join("")).join("\n");
+        const allLabelsXUnique = Array.from(new Set(allLabelsX));
+        for (let i = 0; i < allLabelsXUnique.length; i++) {
+            const regex = new RegExp(allLabelsXUnique[i], "g");
+            chartString = chartString.replace(regex, `\x1b[90m${allLabelsXUnique[i]}\x1b[0m`);
+        }
+        console.log(`\n${chartString}\n`);
+    }
+    else {
+        const xValues = data.map((d) => {
+            const val = d[x];
+            return val instanceof Date ? val.getTime() : val;
+        });
+        const xMin = (0, d3_array_1.min)(xValues);
+        const xMax = (0, d3_array_1.max)(xValues);
+        const yValues = data.map((d) => d[y]);
+        const yMin = (0, d3_array_1.min)(yValues);
+        const yMax = (0, d3_array_1.max)(yValues);
+        if (xMin === undefined ||
+            xMax === undefined ||
+            yMin === undefined ||
+            yMax === undefined) {
+            throw new Error("The min or max value is undefined.");
+        }
+        if (data.length > width) {
+            if (type === "line") {
+                console.log("\x1b[2m\n/!\\ Number of values greater than width. Averaged values displayed.\x1b[0m");
+            }
+            else if (type === "dot") {
+                console.log("\x1b[2m\n/!\\ Number of values greater than width. Dots might overlap.\x1b[0m");
+            }
+        }
+        const { chart, xLabels } = (0, drawChart_js_1.default)(type, drawFunction, data, x, y, "\x1b[38;5;208m", {
+            formatX: formatX,
+            formatY: formatY,
+            width: width,
+            height: height,
+            xMin,
+            xMax,
+            yMin,
+            yMax,
+        });
+        let chartString = chart.map((d) => d.join("")).join("\n");
+        const allLabelsXUnique = Array.from(new Set(xLabels));
+        for (let i = 0; i < allLabelsXUnique.length; i++) {
+            const regex = new RegExp(allLabelsXUnique[i], "g");
+            chartString = chartString.replace(regex, `\x1b[90m${allLabelsXUnique[i]}\x1b[0m`);
+        }
+        console.log(`${chartString}`);
+    }
+}

package/script/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/helpers/validateDataTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateDataTypes.d.ts","sourceRoot":"","sources":["../../../../../../../../../src/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/helpers/validateDataTypes.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACvC,IAAI,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,EAAE,EAClC,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,QAsCV"}

package/script/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/logBarChart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logBarChart.d.ts","sourceRoot":"","sources":["../../../../../../../../src/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/logBarChart.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnE,IAAI,EAAE,CAAC,EAAE,EACT,MAAM,EAAE,MAAM,CAAC,EACf,MAAM,EAAE,MAAM,CAAC,EACf,OAAO,GAAE;IACP,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,MAAM,CAAC,KAAK,MAAM,CAAC;IAC/C,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,MAAM,CAAC,KAAK,MAAM,CAAC;IAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;CACd,GACL,IAAI,CA6BN"}

package/script/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/logBarChart.js

@@ -0,0 +1,73 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = logBarChart;
+const index_js_1 = require("../../../../journalism-format/1.1.9/src/index.js");
+const makeBars_js_1 = __importDefault(require("./helpers/makeBars.js"));
+/**
+ * Generates and logs a text-based bar chart to the console. This function is useful for quickly visualizing data distributions or comparisons directly within a terminal or log output, without needing a graphical interface. It's particularly effective for presenting categorical data or showing the relative magnitudes of different items.
+ *
+ * The chart is constructed using ASCII characters, making it universally compatible across various terminal environments. It can display data for various categories and their corresponding numerical values, with extensive options for custom formatting of labels and values, controlling the chart's width, and adding a descriptive title or a total label. For optimal visualization, it's recommended that the input `data` be sorted by the `values` key in descending order, though the function does not enforce this.
+ *
+ * @param data - An array of objects, where each object represents a bar in the chart. Each object should contain keys corresponding to the `labels` and `values` parameters.
+ * @param labels - The key in the data objects whose values will be used as textual labels for each bar (e.g., 'category', 'name', 'country').
+ * @param values - The key in the data objects whose numerical values will determine the length of each bar and be displayed alongside the labels (e.g., 'sales', 'count', 'percentage').
+ * @param options - Optional configuration for customizing the appearance and behavior of the chart.
+ * @param options.formatLabels - A function to format the labels displayed on the chart. It receives the raw label value as input and should return a string. Defaults to converting the label to a string.
+ * @param options.formatValues - A function to format the numerical values displayed next to the bars. It receives the raw numerical value as input and should return a string. Defaults to formatting the number using `formatNumber` (which adds commas for thousands, etc.).
+ * @param options.width - The maximum width of the bars in characters. The bars will scale proportionally to this width. A larger width allows for more detailed visualization. Defaults to `40`.
+ * @param options.title - An optional title to display above the chart. If not provided, a default title based on `labels` and `values` keys will be generated.
+ * @param options.totalLabel - An optional label to display for the total sum of all values at the bottom of the chart. If provided, the sum of all `values` will be calculated and displayed next to this label.
+ * @param options.compact - If `true`, the chart will be rendered in a more compact format, reducing vertical spacing between bars. Defaults to `false`.
+ *
+ * @example
+ * ```ts
+ * // Visualize sales data for different regions.
+ * const salesData = [
+ *   { region: 'North', sales: 1200 },
+ *   { region: 'South', sales: 800 },
+ *   { region: 'East', sales: 1500 },
+ *   { region: 'West', sales: 950 }
+ * ];
+ * logBarChart(salesData, 'region', 'sales', { title: 'Regional Sales Overview' });
+ * ```
+ * @example
+ * ```ts
+ * // Display product popularity with custom value formatting and a compact layout.
+ * const productPopularity = [
+ *   { product: 'Laptop', views: 5000 },
+ *   { product: 'Mouse', views: 1500 },
+ *   { product: 'Keyboard', views: 2500 }
+ * ];
+ * logBarChart(productPopularity, 'product', 'views', {
+ *   formatValues: (v) => `${v / 1000}K`,
+ *   width: 30,
+ *   compact: true,
+ *   totalLabel: 'Total Views'
+ * });
+ * ```
+ * @returns {void}
+ * @category Dataviz
+ */
+function logBarChart(data, labels, values, options = {}) {
+    if (options.title) {
+        console.log(`\n${options.title}`);
+    }
+    else {
+        console.log(`\nBar chart of "${String(values)}" per "${String(labels)}":`);
+    }
+    const formatLabels = options.formatLabels ??
+        function (d) {
+            return String(d);
+        };
+    const formatValues = options.formatValues ??
+        function (d) {
+            return (0, index_js_1.formatNumber)(d);
+        };
+    const width = options.width ?? 40;
+    const chartData = (0, makeBars_js_1.default)(data, "\x1b[38;5;55m", // Darker purple color
+    String(labels), String(values), (d) => formatLabels(d), (d) => formatValues(d), width, options.compact ?? false, options.totalLabel);
+    console.log(chartData.join("\n"));
+}

package/script/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/logDotChart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logDotChart.d.ts","sourceRoot":"","sources":["../../../../../../../../src/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/logDotChart.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnE,IAAI,EAAE,CAAC,EAAE,EACT,CAAC,EAAE,MAAM,CAAC,EACV,CAAC,EAAE,MAAM,CAAC,EACV,OAAO,GAAE;IACP,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,MAAM,CAAC;IACrC,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,MAAM,CAAC;IACrC,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC;IACzB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CACX,GACL,IAAI,CAyBN"}

package/script/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/logLineChart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logLineChart.d.ts","sourceRoot":"","sources":["../../../../../../../../src/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/logLineChart.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpE,IAAI,EAAE,CAAC,EAAE,EACT,CAAC,EAAE,MAAM,CAAC,EACV,CAAC,EAAE,MAAM,CAAC,EACV,OAAO,GAAE;IACP,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,MAAM,CAAC;IACrC,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,MAAM,CAAC;IACrC,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC;IACzB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CACX,GACL,IAAI,CAyBN"}

package/script/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/publishChartDW.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"publishChartDW.d.ts","sourceRoot":"","sources":["../../../../../../../../src/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/publishChartDW.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAA8B,cAAc,CAC1C,OAAO,EAAE,MAAM,EACf,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,cAAc,CAAC,EAAE,OAAO,CAAA;CAAO,GAC1D,OAAO,CAAC,IAAI,GAAG,QAAQ,CAAC,CA4B1B"}

package/script/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/rewind.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rewind.d.ts","sourceRoot":"","sources":["../../../../../../../../src/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/rewind.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,CAAC,OAAO,UAAU,MAAM,CAE5B,MAAM,EAAE,GAAG,GAEV,GAAG,CAiBL"}

package/script/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/saveChart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"saveChart.d.ts","sourceRoot":"","sources":["../../../../../../../../src/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/saveChart.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAA8B,SAAS,CAErC,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,EAEpC,KAAK,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,KAAK,aAAa,GAAG,WAAW,EAC5E,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,OAAO,CAAA;CAAO,GAC/C,OAAO,CAAC,IAAI,CAAC,CAolBf"}