@nshiab/simple-data-analysis 5.19.12 → 5.19.13

package/esm/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/logDotChart.js

@@ -1,91 +0,0 @@
-import addDots from "./helpers/addDots.js";
-import prepChart from "./helpers/prepChart.js";
-/**
- * Generates and logs a text-based dot chart to the console. This function is ideal for visualizing the relationship between two numerical variables. It provides a quick, terminal-friendly way to inspect data trends and distributions.
- *
- * The chart is rendered using ASCII characters, ensuring compatibility across various terminal environments. It supports custom formatting for both x and y-axis values, and can generate small multiples to compare distributions across different categories. While the function expects data to be sorted by the x-axis values for proper rendering, it does not enforce this.
- *
- * **Data Type Requirements:**
- * - **X-axis values**: Must be `number` or `Date` objects.
- * - **Y-axis values**: Must be `number` values.
- * - All values must be non-null and defined.
- *
- * @param data - An array of objects representing the data to be visualized. Each object should contain keys corresponding to the `x` and `y` parameters.
- * @param x - The key in the data objects whose values will be plotted on the x-axis. Values must be numbers or Date objects.
- * @param y - The key in the data objects whose values will be plotted on the y-axis. Values must be numbers.
- * @param options - An optional object to customize the chart's appearance and behavior.
- * @param options.formatX - A function to format the x-axis values for display. It receives the raw x-value as input and should return a string. If the first data point's x value is a Date, it defaults to formatting the date as "YYYY-MM-DD".
- * @param options.formatY - A function to format the y-axis values for display. It receives the raw y-value as input and should return a string.
- * @param options.smallMultiples - A key in the data objects to create small multiples (separate charts) for each unique value of this key. This is useful for comparing trends across different categories.
- * @param options.fixedScales - If `true` and `smallMultiples` is used, all small multiple charts will share the same x and y scales, allowing for direct comparison of magnitudes. If `false`, each small multiple will have its own independent scales. Defaults to `false`.
- * @param options.smallMultiplesPerRow - The number of small multiples to display per row when `smallMultiples` is used. Defaults to `3`.
- * @param options.width - The width of the chart in characters. This affects the horizontal resolution of the chart. Defaults to `60`.
- * @param options.height - The height of the chart in lines. This affects the vertical resolution of the chart. Defaults to `20`.
- * @param options.title - The title of the chart. If not provided, a default title based on `x`, `y`, and `smallMultiples` (if applicable) will be generated.
- *
- * @example
- * ```ts
- * // Visualize a time series of values.
- * const timeSeriesData = [
- *     { date: new Date("2023-01-01"), value: 10 },
- *     { date: new Date("2023-02-01"), value: 20 },
- *     { date: new Date("2023-03-01"), value: 30 },
- *     { date: new Date("2023-04-01"), value: 40 },
- * ];
- *
- * logDotChart(timeSeriesData, "date", "value", {
- *     formatX: (d) => (d as Date).toISOString().slice(0, 10),
- *     formatY: (d) => "$" + (d as number).toString(),
- *     title: "Monthly Sales Trend",
- * });
- * ```
- *
- * @example
- * ```ts
- * // Compare trends across different categories using small multiples.
- * const multiCategoryData = [
- *     { date: new Date("2023-01-01"), value: 10, category: "A" },
- *     { date: new Date("2023-02-01"), value: 20, category: "A" },
- *     { date: new Date("2023-03-01"), value: 30, category: "A" },
- *     { date: new Date("2023-04-01"), value: 40, category: "A" },
- *     { date: new Date("2023-01-01"), value: 15, category: "B" },
- *     { date: new Date("2023-02-01"), value: 25, category: "B" },
- *     { date: new Date("2023-03-01"), value: 35, category: "B" },
- *     { date: new Date("2023-04-01"), value: 45, category: "B" },
- * ];
- *
- * logDotChart(multiCategoryData, "date", "value", {
- *     formatX: (d) => (d as Date).toISOString().slice(0, 10),
- *     formatY: (d) => "$" + (d as number).toString(),
- *     smallMultiples: "category",
- *     smallMultiplesPerRow: 2,
- *     fixedScales: true,
- *     title: "Sales Trend by Category",
- * });
- * ```
- *
- * @returns {void}
- * @category Dataviz
- */
-export default function logDotChart(data, x, y, options = {}) {
-    if (options.title) {
-        console.log(`\n${options.title}`);
-    }
-    else {
-        console.log(`\nDot chart of "${String(y)}" over "${String(x)}"${options.smallMultiples
-            ? `, for each "${String(options.smallMultiples)}"`
-            : ""}:`);
-    }
-    prepChart("dot", data, String(x), String(y), addDots, {
-        ...options,
-        formatX: options.formatX
-            ? (d) => options.formatX(d)
-            : undefined,
-        formatY: options.formatY
-            ? (d) => options.formatY(d)
-            : undefined,
-        smallMultiples: options.smallMultiples
-            ? String(options.smallMultiples)
-            : undefined,
-    });
-}

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

@@ -1,77 +0,0 @@
-/**
- * Generates and logs a text-based line chart to the console. This function is particularly useful for visualizing trends over time providing a quick and accessible way to understand data progression directly within a terminal or log output.
- *
- * The chart is rendered using ASCII characters, ensuring broad compatibility. It supports custom formatting for both x and y-axis values, and can generate small multiples to compare trends across different categories. When the chart's width is smaller than the number of data points, the line represents an averaged approximation of the data, providing a smoothed view of the trend. For optimal visualization, it's recommended that the input `data` be sorted by the x-axis values.
- *
- * **Data Type Requirements:**
- * - **X-axis values**: Must be `number` or `Date` objects.
- * - **Y-axis values**: Must be `number` values.
- * - All values must be non-null and defined.
- *
- * @param data - An array of objects representing the data to be visualized. Each object should contain keys corresponding to the `x` and `y` parameters.
- * @param x - The key in the data objects whose values will be plotted on the x-axis. Values must be numbers or Date objects.
- * @param y - The key in the data objects whose values will be plotted on the y-axis. Values must be numbers.
- * @param options - An optional object to customize the chart's appearance and behavior.
- * @param options.formatX - A function to format the x-axis values for display. It receives the raw x-value as input and should return a string. If the first data point's x value is a Date, it defaults to formatting the date as "YYYY-MM-DD".
- * @param options.formatY - A function to format the y-axis values for display. It receives the raw y-value as input and should return a string.
- * @param options.smallMultiples - A key in the data objects to create small multiples (separate charts) for each unique value of this key. This is useful for comparing trends across different categories.
- * @param options.fixedScales - If `true` and `smallMultiples` is used, all small multiple charts will share the same x and y scales, allowing for direct comparison of magnitudes. If `false`, each small multiple will have its own independent scales. Defaults to `false`.
- * @param options.smallMultiplesPerRow - The number of small multiples to display per row when `smallMultiples` is used. Defaults to `3`.
- * @param options.width - The width of the chart in characters. This affects the horizontal resolution of the chart. Defaults to `60`.
- * @param options.height - The height of the chart in lines. This affects the vertical resolution of the chart. Defaults to `20`.
- * @param options.title - The title of the chart. If not provided, a default title based on `x`, `y`, and `smallMultiples` (if applicable) will be generated.
- *
- * @example
- * ```ts
- * // Visualize a simple time series of values.
- * const timeSeriesData = [
- *     { date: new Date("2023-01-01"), value: 10 },
- *     { date: new Date("2023-02-01"), value: 20 },
- *     { date: new Date("2023-03-01"), value: 30 },
- *     { date: new Date("2023-04-01"), value: 40 },
- * ];
- *
- * logLineChart(timeSeriesData, "date", "value", {
- *     formatX: (d) => (d as Date).toISOString().slice(0, 10),
- *     title: "Monthly Data Trend",
- * });
- * ```
- *
- * @example
- * ```ts
- * // Compare trends across different categories using small multiples.
- * const multiCategoryData = [
- *     { date: new Date("2023-01-01"), value: 10, category: "A" },
- *     { date: new Date("2023-02-01"), value: 20, category: "A" },
- *     { date: new Date("2023-03-01"), value: 30, category: "A" },
- *     { date: new Date("2023-04-01"), value: 40, category: "A" },
- *     { date: new Date("2023-01-01"), value: 15, category: "B" },
- *     { date: new Date("2023-02-01"), value: 25, category: "B" },
- *     { date: new Date("2023-03-01"), value: 35, category: "B" },
- *     { date: new Date("2023-04-01"), value: 45, category: "B" },
- * ];
- *
- * logLineChart(multiCategoryData, "date", "value", {
- *     formatX: (d) => (d as Date).toLocaleDateString(),
- *     formatY: (d) => "$" + (d as number).toString(),
- *     smallMultiples: "category",
- *     smallMultiplesPerRow: 2,
- *     fixedScales: true,
- *     title: "Sales Trend by Category",
- * });
- * ```
- *
- * @returns {void}
- * @category Dataviz
- */
-export default function logLineChart<T extends Record<string, unknown>>(data: T[], x: keyof T, y: keyof T, options?: {
-    formatX?: (d: T[typeof x]) => string;
-    formatY?: (d: T[typeof y]) => string;
-    smallMultiples?: keyof T;
-    fixedScales?: boolean;
-    smallMultiplesPerRow?: number;
-    width?: number;
-    height?: number;
-    title?: string;
-}): void;
-//# sourceMappingURL=logLineChart.d.ts.map

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

@@ -1 +0,0 @@
-{"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/esm/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/logLineChart.js

@@ -1,90 +0,0 @@
-import addLines from "./helpers/addLines.js";
-import prepChart from "./helpers/prepChart.js";
-/**
- * Generates and logs a text-based line chart to the console. This function is particularly useful for visualizing trends over time providing a quick and accessible way to understand data progression directly within a terminal or log output.
- *
- * The chart is rendered using ASCII characters, ensuring broad compatibility. It supports custom formatting for both x and y-axis values, and can generate small multiples to compare trends across different categories. When the chart's width is smaller than the number of data points, the line represents an averaged approximation of the data, providing a smoothed view of the trend. For optimal visualization, it's recommended that the input `data` be sorted by the x-axis values.
- *
- * **Data Type Requirements:**
- * - **X-axis values**: Must be `number` or `Date` objects.
- * - **Y-axis values**: Must be `number` values.
- * - All values must be non-null and defined.
- *
- * @param data - An array of objects representing the data to be visualized. Each object should contain keys corresponding to the `x` and `y` parameters.
- * @param x - The key in the data objects whose values will be plotted on the x-axis. Values must be numbers or Date objects.
- * @param y - The key in the data objects whose values will be plotted on the y-axis. Values must be numbers.
- * @param options - An optional object to customize the chart's appearance and behavior.
- * @param options.formatX - A function to format the x-axis values for display. It receives the raw x-value as input and should return a string. If the first data point's x value is a Date, it defaults to formatting the date as "YYYY-MM-DD".
- * @param options.formatY - A function to format the y-axis values for display. It receives the raw y-value as input and should return a string.
- * @param options.smallMultiples - A key in the data objects to create small multiples (separate charts) for each unique value of this key. This is useful for comparing trends across different categories.
- * @param options.fixedScales - If `true` and `smallMultiples` is used, all small multiple charts will share the same x and y scales, allowing for direct comparison of magnitudes. If `false`, each small multiple will have its own independent scales. Defaults to `false`.
- * @param options.smallMultiplesPerRow - The number of small multiples to display per row when `smallMultiples` is used. Defaults to `3`.
- * @param options.width - The width of the chart in characters. This affects the horizontal resolution of the chart. Defaults to `60`.
- * @param options.height - The height of the chart in lines. This affects the vertical resolution of the chart. Defaults to `20`.
- * @param options.title - The title of the chart. If not provided, a default title based on `x`, `y`, and `smallMultiples` (if applicable) will be generated.
- *
- * @example
- * ```ts
- * // Visualize a simple time series of values.
- * const timeSeriesData = [
- *     { date: new Date("2023-01-01"), value: 10 },
- *     { date: new Date("2023-02-01"), value: 20 },
- *     { date: new Date("2023-03-01"), value: 30 },
- *     { date: new Date("2023-04-01"), value: 40 },
- * ];
- *
- * logLineChart(timeSeriesData, "date", "value", {
- *     formatX: (d) => (d as Date).toISOString().slice(0, 10),
- *     title: "Monthly Data Trend",
- * });
- * ```
- *
- * @example
- * ```ts
- * // Compare trends across different categories using small multiples.
- * const multiCategoryData = [
- *     { date: new Date("2023-01-01"), value: 10, category: "A" },
- *     { date: new Date("2023-02-01"), value: 20, category: "A" },
- *     { date: new Date("2023-03-01"), value: 30, category: "A" },
- *     { date: new Date("2023-04-01"), value: 40, category: "A" },
- *     { date: new Date("2023-01-01"), value: 15, category: "B" },
- *     { date: new Date("2023-02-01"), value: 25, category: "B" },
- *     { date: new Date("2023-03-01"), value: 35, category: "B" },
- *     { date: new Date("2023-04-01"), value: 45, category: "B" },
- * ];
- *
- * logLineChart(multiCategoryData, "date", "value", {
- *     formatX: (d) => (d as Date).toLocaleDateString(),
- *     formatY: (d) => "$" + (d as number).toString(),
- *     smallMultiples: "category",
- *     smallMultiplesPerRow: 2,
- *     fixedScales: true,
- *     title: "Sales Trend by Category",
- * });
- * ```
- *
- * @returns {void}
- * @category Dataviz
- */
-export default function logLineChart(data, x, y, options = {}) {
-    if (options.title) {
-        console.log(`\n${options.title}`);
-    }
-    else {
-        console.log(`\nLine chart of "${String(y)}" over "${String(x)}"${options.smallMultiples
-            ? `, for each "${String(options.smallMultiples)}"`
-            : ""}:`);
-    }
-    prepChart("line", data, String(x), String(y), addLines, {
-        ...options,
-        formatX: options.formatX
-            ? (d) => options.formatX(d)
-            : undefined,
-        formatY: options.formatY
-            ? (d) => options.formatY(d)
-            : undefined,
-        smallMultiples: options.smallMultiples
-            ? String(options.smallMultiples)
-            : undefined,
-    });
-}

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

@@ -1 +0,0 @@
-{"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/esm/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/rewind.d.ts.map

@@ -1 +0,0 @@
-{"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/esm/deps/jsr.io/@nshiab/journalism-dataviz/1.0.15/src/dataviz/saveChart.d.ts.map

@@ -1 +0,0 @@
-{"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"}