forked from observablehq/plot
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathauto.js
More file actions
329 lines (303 loc) · 11.2 KB
/
auto.js
File metadata and controls
329 lines (303 loc) · 11.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
import {ascending, InternSet} from "d3";
import {isOrdinal, labelof, valueof, isOptions, isColor, isObject} from "../options.js";
import {areaX, areaY} from "./area.js";
import {dot} from "./dot.js";
import {line, lineX, lineY} from "./line.js";
import {ruleX, ruleY} from "./rule.js";
import {barX, barY} from "./bar.js";
import {rect, rectX, rectY} from "./rect.js";
import {cell} from "./cell.js";
import {frame} from "./frame.js";
import {bin, binX, binY} from "../transforms/bin.js";
import {group, groupX, groupY} from "../transforms/group.js";
import {marks} from "../mark.js";
export function autoSpec(data, options) {
options = normalizeOptions(options);
let {
fx,
fy,
x: {value: xValue, reduce: xReduce, zero: xZero, ...xOptions},
y: {value: yValue, reduce: yReduce, zero: yZero, ...yOptions},
color: {value: colorValue, color: colorColor, reduce: colorReduce},
size: {value: sizeValue, reduce: sizeReduce}, // TODO constant radius?
mark
} = options;
// Lazily materialize x and y columns for type inference, if needed.
const {x, y} = options;
let X, Y;
// Determine the default reducer, if any.
if (xReduce === undefined)
xReduce = yReduce == null && xValue == null && sizeValue == null && yValue != null ? "count" : null;
if (yReduce === undefined)
yReduce = xReduce == null && yValue == null && sizeValue == null && xValue != null ? "count" : null;
// Determine the default size reducer, if any.
if (
sizeReduce === undefined &&
sizeValue == null &&
colorReduce == null &&
xReduce == null &&
yReduce == null &&
(xValue == null || isOrdinal((X ??= materializeValue(data, x)))) &&
(yValue == null || isOrdinal((Y ??= materializeValue(data, y))))
) {
sizeReduce = "count";
}
// Determine the default zero-ness.
if (xZero === undefined) xZero = isZeroReducer(xReduce) ? true : undefined;
if (yZero === undefined) yZero = isZeroReducer(yReduce) ? true : undefined;
// TODO Shorthand: array of primitives should result in a histogram
if (xValue == null && yValue == null) throw new Error("must specify x or y");
if (xReduce != null && yValue == null) throw new Error("reducing x requires y");
if (yReduce != null && xValue == null) throw new Error("reducing y requires x");
// Determine the default mark type.
if (mark === undefined) {
mark =
sizeValue != null || sizeReduce != null
? "dot"
: xZero || yZero || colorReduce != null // histogram or heatmap
? "bar"
: xValue != null && yValue != null
? isOrdinal((X ??= materializeValue(data, x))) ||
isOrdinal((Y ??= materializeValue(data, y))) ||
(xReduce == null && yReduce == null && !isMonotonic(X) && !isMonotonic(Y))
? "dot"
: "line"
: xValue != null || yValue != null
? "rule"
: null;
}
return {
fx: fx ?? null,
fy: fy ?? null,
x: {
value: xValue ?? null,
reduce: xReduce ?? null,
...(xZero !== undefined && {zero: xZero}), // TODO realize default
...xOptions
},
y: {
value: yValue ?? null,
reduce: yReduce ?? null,
...(yZero !== undefined && {zero: yZero}), // TODO realize default
...yOptions
},
color: {
value: colorValue ?? null,
reduce: colorReduce ?? null,
...(colorColor !== undefined && {color: colorColor})
},
size: {
value: sizeValue ?? null,
reduce: sizeReduce ?? null
},
mark
};
}
/** @jsdoc auto */
export function auto(data, options) {
options = normalizeOptions(options);
// Greedily materialize columns for type inference; we’ll need them anyway to
// plot! Note that we don’t apply any type inference to the fx and fy
// channels, if present; these are always ordinal (at least for now).
const {x, y, color, size} = options;
const X = materializeValue(data, x);
const Y = materializeValue(data, y);
const C = materializeValue(data, color);
const S = materializeValue(data, size);
// Compute the default options via autoSpec.
let {
fx,
fy,
x: {reduce: xReduce, zero: xZero, ...xOptions},
y: {reduce: yReduce, zero: yZero, ...yOptions},
color: {color: colorColor, reduce: colorReduce},
size: {reduce: sizeReduce},
mark
} = autoSpec(data, {
...options,
x: {...x, value: X},
y: {...y, value: Y},
color: {...color, value: C},
size: {...size, value: S}
});
let Z; // may be set to null to disable series-by-color for line and area
let colorMode; // "fill" or "stroke"
// Determine the mark implementation.
if (mark != null) {
switch (`${mark}`.toLowerCase()) {
case "dot":
mark = dot;
colorMode = "stroke";
break;
case "line":
mark = X && Y ? line : X ? lineX : lineY; // 1d line by index
colorMode = "stroke";
if (isHighCardinality(C)) Z = null; // TODO only if z not set by user
break;
case "area":
mark = yZero ? areaY : xZero || (Y && isMonotonic(Y)) ? areaX : areaY; // favor areaY if unsure
colorMode = "fill";
if (isHighCardinality(C)) Z = null; // TODO only if z not set by user
break;
case "rule":
mark = X ? ruleX : ruleY;
colorMode = "stroke";
break;
case "bar":
mark = yZero
? isOrdinalReduced(xReduce, X)
? barY
: rectY
: xZero
? isOrdinalReduced(yReduce, Y)
? barX
: rectX
: isOrdinalReduced(xReduce, X) && isOrdinalReduced(yReduce, Y)
? cell
: isOrdinalReduced(xReduce, X)
? barY
: isOrdinalReduced(yReduce, Y)
? barX
: rect;
colorMode = "fill";
break;
default:
throw new Error(`invalid mark: ${mark}`);
}
}
// Determine the mark options.
let markOptions = {
fx,
fy,
x: X ?? undefined, // treat null x as undefined for implicit stack
y: Y ?? undefined, // treat null y as undefined for implicit stack
[colorMode]: C ?? colorColor,
z: Z,
r: S ?? undefined // treat null size as undefined for default constant radius
};
let transform;
let transformOptions = {[colorMode]: colorReduce ?? undefined, r: sizeReduce ?? undefined};
if (xReduce != null && yReduce != null) {
throw new Error(`cannot reduce both x and y`); // for now at least
} else if (yReduce != null) {
transformOptions.y = yReduce;
transform = isOrdinal(X) ? groupX : binX;
} else if (xReduce != null) {
transformOptions.x = xReduce;
transform = isOrdinal(Y) ? groupY : binY;
} else if (colorReduce != null || sizeReduce != null) {
if (X && Y) {
transform = isOrdinal(X) && isOrdinal(Y) ? group : isOrdinal(X) ? binY : isOrdinal(Y) ? binX : bin;
} else if (X) {
transform = isOrdinal(X) ? groupX : binX;
} else if (Y) {
transform = isOrdinal(Y) ? groupY : binY;
}
}
if (transform) {
if (transform === bin || transform === binX) markOptions.x = {value: X, ...xOptions};
if (transform === bin || transform === binY) markOptions.y = {value: Y, ...yOptions};
markOptions = transform(transformOptions, markOptions);
}
// If zero-ness is not specified, default based on whether the resolved mark
// type will include a zero baseline. TODO Move this to autoSpec.
if (xZero === undefined) xZero = transform !== binX && (mark === barX || mark === areaX || mark === rectX);
if (yZero === undefined) yZero = transform !== binY && (mark === barY || mark === areaY || mark === rectY);
// In the case of filled marks (particularly bars and areas) the frame and
// rules should come after the mark; in the case of stroked marks
// (particularly dots and lines) they should come before the mark.
const frames = fx != null || fy != null ? frame({strokeOpacity: 0.1}) : null;
const rules = [xZero ? ruleX([0]) : null, yZero ? ruleY([0]) : null];
mark = mark(data, markOptions);
return colorMode === "stroke" ? marks(frames, rules, mark) : marks(frames, mark, rules);
}
// TODO What about sorted within series?
function isMonotonic(values) {
let previous;
let previousOrder;
for (const value of values) {
if (value == null) continue;
if (previous === undefined) {
previous = value;
continue;
}
const order = Math.sign(ascending(previous, value));
if (!order) continue; // skip zero, NaN
if (previousOrder !== undefined && order !== previousOrder) return false;
previous = value;
previousOrder = order;
}
return true;
}
// Allow x and y and other dimensions to be specified as shorthand field names
// (but note that they can also be specified as a {transform} object such as
// Plot.identity). We don’t support reducers for the faceting, but for symmetry
// with x and y we allow facets to be specified as {value} objects.
function normalizeOptions({x, y, color, size, fx, fy, mark} = {}) {
if (!isOptions(x)) x = makeOptions(x);
if (!isOptions(y)) y = makeOptions(y);
if (!isOptions(color)) color = isColor(color) ? {color} : makeOptions(color);
if (!isOptions(size)) size = makeOptions(size);
if (isOptions(fx)) ({value: fx} = makeOptions(fx));
if (isOptions(fy)) ({value: fy} = makeOptions(fy));
return {x, y, color, size, fx, fy, mark};
}
// To apply heuristics based on the data types (values), realize the columns. We
// could maybe look at the data.schema here, but Plot’s behavior depends on the
// actual values anyway, so this probably is what we want.
function materializeValue(data, options) {
const V = valueof(data, options.value);
if (V) V.label = labelof(options.value);
return V;
}
function makeOptions(value) {
return isReducer(value) ? {reduce: value} : {value};
}
// The distinct, count, sum, and proportion reducers are additive (stackable).
function isZeroReducer(reduce) {
return /^(?:distinct|count|sum|proportion)$/i.test(reduce);
}
// The first, last, and mode reducers preserve the type of the aggregated values.
function isSelectReducer(reduce) {
return /^(?:first|last|mode)$/i.test(reduce);
}
// We can’t infer the type of a custom reducer without invoking it, so
// assume most reducers produce quantitative values.
function isOrdinalReduced(reduce, value) {
return (reduce != null && !isSelectReducer(reduce)) || !value ? false : isOrdinal(value);
}
// https://github.com/observablehq/plot/blob/818562649280e155136f730fc496e0b3d15ae464/src/transforms/group.js#L236
function isReducer(reduce) {
if (typeof reduce?.reduce === "function" && isObject(reduce)) return true; // N.B. array.reduce
if (/^p\d{2}$/i.test(reduce)) return true;
switch (`${reduce}`.toLowerCase()) {
case "first":
case "last":
case "count":
case "distinct":
case "sum":
case "proportion":
case "proportion-facet": // TODO remove me?
case "deviation":
case "min":
case "min-index": // TODO remove me?
case "max":
case "max-index": // TODO remove me?
case "mean":
case "median":
case "variance":
case "mode":
// These are technically reducers, but I think we’d want to treat them as fields?
// case "x":
// case "x1":
// case "x2":
// case "y":
// case "y1":
// case "y2":
return true;
}
return false;
}
function isHighCardinality(value) {
return value ? new InternSet(value).size > value.length >> 1 : false;
}