Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 536x 536x 536x 536x 536x 536x 536x 536x 536x 536x 536x 536x 536x 536x 536x 536x 536x 2360x 536x 536x 536x 536x 536x 536x 536x 536x 536x 536x 536x 536x 536x 536x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 536x 536x 536x 527x 527x 524x 524x 524x 524x 536x 309x 309x 1x 1x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 349x 237x 237x 349x 1x 1x 349x 349x 2039x 2039x 349x 349x 1x 1x 9x 9x 9x 9x 9x 9x 9x 9x 9x 9x 9x 9x 9x 1x 1x 2x 2x 1x 1x 349x 349x 349x 78x 78x 78x 282x 282x 282x 62x 62x 62x 220x 220x 220x 78x 78x 78x 78x 78x 62x 78x 78x 78x 78x 78x 1x 1x 349x 349x 349x 349x 349x 349x 9x 9x 9x 9x 9x 9x 9x 9x 9x 66x 65x 9x 9x 340x 340x 77x 77x 77x 77x 77x 77x 77x 77x 77x 77x 77x 77x 1x 1x 1x 1x 2416x 2416x 2416x 2416x 1x 1x 263x 263x 263x 263x 263x 263x 263x 263x 263x 263x 263x 263x 263x 263x 263x 1x 1x 1x 1x 1x 1x 1x 17x 17x 1x 1x 15x 15x 1x 1x 1x 1x 66x 44x 44x 1x 1x 53x 53x 53x 53x 53x 53x 1x 1x 3x 3x 1x 1x 1x 1x 1x 1x 1x 1x 1x 96x 96x 96x 1x 1x 4x 4x 1x 1x 855x 855x 853x 853x 853x 853x 855x 855x 855x 855x 855x 1x 1x 601x 601x 601x 1x 1x 197x 197x 197x 197x 197x 197x 1x 1x 1x 1x 1x 1x 212x 212x 212x 212x 149x 149x 149x 149x 149x 149x 212x 212x 1x 1x 1x 81x 81x 81x 81x 1x 1x 1x 55x 55x 1x 1x 1x 1x 37x 37x 1x 1x 4x 4x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 6x 6x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 15x 15x 15x 783x 783x 783x 783x 783x 15x 15x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 118x 118x 118x 118x 118x 118x 118x 118x 118x 4609x 118x 118x 118x 118x 3883x 3883x 3883x 3883x 3883x 118x 118x 1x 1x 10x 29x 29x 6x 29x 10x 10x 1x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 5x 10x 2x 10x 10x 5x 5x 5x 5x 5x 5x 5x 5x 1x 1x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 1x 1x 95x 95x 95x 95x 95x 95x 95x 95x 95x 95x 95x 95x 95x 95x 95x 1x 1x 19x 19x 19x 19x 19x 19x 19x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 9x 9x 9x 9x 9x 66x 18x 18x 18x 66x 9x 9x 9x 9x 9x 9x 9x 1x 1x 239x 239x 1x 1x 7x 7x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 349x 349x 1x 1x 19x 19x 1x 1x 28x 28x 28x 28x 1x 1x 449x 449x 1x 1x 421x 421x 1x 1x 110x 110x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 426x 426x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 536x 536x 527x 536x 309x 309x 309x 309x 1x 1x 1x 1x 1x 1x 1x 1x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 19x 19x 19x 19x 19x 1x 1x 2x 2x 1x 1x 2x 2x 2x 2x 2x 2x 2x 1x 1x 82x 82x 1x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 9x 9x 9x 9x 9x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 8x 8x 8x 8x 8x | import {
formatYear,
csvEscape,
min,
max,
range,
difference,
intersection,
flatten,
sum,
uniqBy,
intersectionOfSets,
isNumber,
} from "../clientUtils/Util"
import { isPresent } from "../clientUtils/isPresent"
import { CoreColumn, ColumnTypeMap, MissingColumn } from "./CoreTableColumns"
import {
CoreColumnStore,
CoreRow,
CoreTableInputOption,
PrimitiveType,
Time,
TransformType,
ValueRange,
CoreQuery,
CoreValueType,
InputType,
CoreMatrix,
TableSlug,
JsTypes,
} from "./CoreTableConstants"
import { ColumnTypeNames, CoreColumnDef } from "./CoreColumnDef"
import {
AlignedTextTableOptions,
toAlignedTextTable,
toDelimited,
toMarkdownTable,
} from "./CoreTablePrinters"
import {
makeAutoTypeFn,
columnStoreToRows,
imemo,
makeKeyFn,
makeRowFromColumnStore,
standardizeSlugs,
concatColumnStores,
rowsToColumnStore,
autodetectColumnDefs,
reverseColumnStore,
renameColumnStore,
replaceRandomCellsInColumnStore,
getDropIndexes,
parseDelimited,
rowsFromMatrix,
cartesianProduct,
sortColumnStore,
emptyColumnsInFirstRowInDelimited,
truncate,
replaceCells,
} from "./CoreTableUtils"
import {
ErrorValueTypes,
isNotErrorValue,
DroppedForTesting,
} from "./ErrorValues"
import { OwidTableSlugs } from "./OwidTableConstants"
import { applyTransforms } from "./Transforms"
import { ColumnSlug } from "../clientUtils/owidTypes"
interface AdvancedOptions {
tableDescription?: string
transformCategory?: TransformType
parent?: CoreTable
filterMask?: FilterMask
tableSlug?: TableSlug
}
// The complex generic with default here just enables you to optionally specify a more
// narrow interface for the input rows. This is helpful for OwidTable.
export class CoreTable<
ROW_TYPE extends CoreRow = CoreRow,
COL_DEF_TYPE extends CoreColumnDef = CoreColumnDef
> {
private _columns: Map<ColumnSlug, CoreColumn> = new Map()
protected parent?: this
tableDescription: string
private timeToLoad = 0
private initTime = Date.now()
private originalInput: CoreTableInputOption
private advancedOptions: AdvancedOptions
private inputColumnDefs: COL_DEF_TYPE[]
constructor(
input: CoreTableInputOption = [],
inputColumnDefs: COL_DEF_TYPE[] | string = [],
advancedOptions: AdvancedOptions = {}
) {
const start = Date.now() // Perf aid
const { parent, tableDescription = "" } = advancedOptions
this.originalInput = input
this.tableDescription = tableDescription
this.parent = parent as this
this.inputColumnDefs =
typeof inputColumnDefs === "string"
? columnDefinitionsFromDelimited<COL_DEF_TYPE>(inputColumnDefs)
: inputColumnDefs
// If any values were passed in, copy those to column store now and then remove them from column definitions.
// todo: remove values property entirely? may be an anti-pattern.
this.inputColumnDefs = this.inputColumnDefs.map((def) => {
if (!def.values) return def
this.valuesFromColumnDefs[def.slug] = def.values
const copy = {
...def,
}
delete copy.values
return copy
})
this.inputColumnDefs.forEach((def) => this.setColumn(def))
this.advancedOptions = advancedOptions
// If this has a parent table, than we expect all defs. This makes "deletes" and "renames" fast.
// If this is the first input table, then we do a simple check to generate any missing column defs.
if (!parent)
autodetectColumnDefs(this.inputColumnStore, this._columns).forEach(
(def) => this.setColumn(def as COL_DEF_TYPE)
)
this.timeToLoad = Date.now() - start // Perf aid
}
private valuesFromColumnDefs: CoreColumnStore = {}
// A method currently used just in debugging but may be useful in the author backend.
// If your charts look funny, a good thing to check is if the autodetected columns are wrong.
get autodetectedColumnDefs(): CoreTable {
const providedSlugs = new Set(
this.inputColumnDefs.map((def) => def.slug)
)
return new CoreTable(
this.defs.filter((def) => !providedSlugs.has(def.slug))
)
}
@imemo get transformCategory(): TransformType {
const { advancedOptions, inputType } = this
if (advancedOptions.transformCategory)
return advancedOptions.transformCategory
if (inputType === InputType.Delimited)
return TransformType.LoadFromDelimited
if (inputType === InputType.Matrix) return TransformType.LoadFromMatrix
if (inputType === InputType.RowStore)
return TransformType.LoadFromRowStore
return TransformType.LoadFromColumnStore
}
// If the input is a column store, returns that. If it is DSV, parses that and turns it into a column store.
// If it is a Rows[], turns it into a column store.
@imemo private get inputColumnStore(): CoreColumnStore {
const { originalInput, inputType } = this
if (inputType === InputType.Delimited)
return this.delimitedAsColumnStore
else if (inputType === InputType.Matrix)
return rowsToColumnStore(
rowsFromMatrix(originalInput as CoreMatrix)
)
else if (inputType === InputType.RowStore)
return rowsToColumnStore(originalInput as CoreRow[])
return originalInput as CoreColumnStore
}
@imemo get columnStore(): CoreColumnStore {
const {
inputColumnStore,
valuesFromColumnDefs,
inputColumnsToParsedColumnStore,
inputColumnDefs,
isRoot,
advancedOptions,
} = this
// Set blank columns
let columnStore = Object.assign(
{},
this.blankColumnStore,
inputColumnStore,
valuesFromColumnDefs
)
// Overwrite any non-parsed columns with parsed values
if (Object.keys(inputColumnsToParsedColumnStore).length)
columnStore = Object.assign(
columnStore,
inputColumnsToParsedColumnStore
)
// NB: transforms are *only* run on the root table for now. They will not be rerun later on (after adding or filtering rows, for example)
const columnsFromTransforms = inputColumnDefs.filter(
(def) => def.transform
) // todo: sort by graph dependency order
if (isRoot && columnsFromTransforms.length)
columnStore = applyTransforms(columnStore, columnsFromTransforms)
return advancedOptions.filterMask
? advancedOptions.filterMask.apply(columnStore)
: columnStore
}
private get blankColumnStore(): CoreColumnStore {
const columnsObject: CoreColumnStore = {}
this.columnSlugs.forEach((slug) => {
columnsObject[slug] = []
})
return columnsObject
}
@imemo private get delimitedAsColumnStore(): CoreColumnStore {
const { originalInput, _numericColumnSlugs } = this
const parsed = parseDelimited(
originalInput as string,
undefined,
makeAutoTypeFn(_numericColumnSlugs)
) as any
// dsv_parse adds a columns prop to the result we don't want since we handle our own column defs.
// https://github.com/d3/d3-dsv#dsv_parse
delete parsed.columns
const renamedRows = standardizeSlugs(parsed) // todo: pass renamed defs back in.
return rowsToColumnStore(renamedRows ? renamedRows.rows : parsed)
}
get tableSlug(): string | undefined {
return this.advancedOptions.tableSlug
}
private get inputColumnsToParsedColumnStore(): CoreColumnStore {
const { inputColumnStore, colsToParse } = this
const columnsObject: CoreColumnStore = {}
if (!colsToParse.length) return columnsObject
const missingCols: CoreColumn[] = []
let len = 0
colsToParse.forEach((col) => {
const { slug } = col
const unparsedVals = inputColumnStore[slug]
if (!unparsedVals) {
missingCols.push(col)
return
}
columnsObject[slug] = unparsedVals.map((val) => col.parse(val))
len = columnsObject[slug].length
})
// If column defs were provided but there were no values provided for those columns, create blank columns the same size
// as the filled columns.
missingCols.forEach(
(col) =>
(columnsObject[col.slug] = range(0, len).map(() =>
col.parse(undefined)
))
)
return columnsObject
}
private get colsToParse(): CoreColumn[] {
const { inputType, columnsAsArray, inputColumnStore } = this
const columnsToMaybeParse = columnsAsArray.filter(
(col) => !col.def.skipParsing
)
const firstInputRow = makeRowFromColumnStore(0, inputColumnStore)
if (inputType === InputType.Delimited) {
const missingTypes = new Set(
this.getColumns(
emptyColumnsInFirstRowInDelimited(
this.originalInput as string
)
)
) // Our autotyping is poor if the first value in a column is empty
return columnsToMaybeParse.filter(
(col) =>
col.needsParsing(firstInputRow[col.slug]) ||
missingTypes.has(col)
)
}
if (this.parent || !firstInputRow) return []
// The default behavior is to assume some missing or bad data in user data, so we always parse the full input the first time we load
// user data, with the exception of columns that have values passed directly.
// Todo: measure the perf hit and add a parameter to opt out of this this if you know the data is complete?
const alreadyTypedSlugs = new Set(
Object.keys(this.valuesFromColumnDefs)
)
if (this.isRoot) {
return columnsToMaybeParse.filter(
(col) => !alreadyTypedSlugs.has(col.slug)
)
}
return columnsToMaybeParse.filter(
(col) =>
!alreadyTypedSlugs.has(col.slug) ||
col.needsParsing(firstInputRow[col.slug])
)
}
toOneDimensionalArray(): any {
return flatten(this.toTypedMatrix().slice(1))
}
private setColumn(def: COL_DEF_TYPE): void {
const { type, slug } = def
const ColumnType = (type && ColumnTypeMap[type]) || ColumnTypeMap.String
this._columns.set(slug, new ColumnType(this, def))
}
protected transform(
rowsOrColumnStore: ROW_TYPE[] | CoreColumnStore | CoreMatrix,
defs: COL_DEF_TYPE[],
tableDescription: string,
transformCategory: TransformType,
filterMask?: FilterMask
): this {
// The combo of the "this" return type and then casting this to any allows subclasses to create transforms of the
// same type. The "any" typing is very brief (the returned type will have the same type as the instance being transformed).
return new (this.constructor as any)(rowsOrColumnStore, defs, {
parent: this,
tableDescription,
transformCategory,
filterMask,
} as AdvancedOptions)
}
// Time between when the parent table finished loading and this table started constructing.
// A large time may just be due to a transform only happening after a user action, or it
// could be do to other sync code executing between transforms.
private get betweenTime(): number {
return this.parent
? this.initTime - (this.parent.initTime + this.parent.timeToLoad)
: 0
}
@imemo get rows(): ROW_TYPE[] {
return columnStoreToRows(this.columnStore) as ROW_TYPE[]
}
@imemo get indices(): number[] {
return range(0, this.numRows)
}
*[Symbol.iterator](): Generator<CoreRow, void, unknown> {
const { columnStore, numRows } = this
for (let index = 0; index < numRows; index++) {
yield makeRowFromColumnStore(index, columnStore)
}
}
getTimesAtIndices(indices: number[]): number[] {
if (!indices.length) return []
return this.getValuesAtIndices(this.timeColumn!.slug, indices) as Time[]
}
getValuesAtIndices(
columnSlug: ColumnSlug,
indices: number[]
): CoreValueType[] {
const values = this.get(columnSlug).valuesIncludingErrorValues
return indices.map((index) => values[index])
}
@imemo get firstRow(): ROW_TYPE {
return makeRowFromColumnStore(0, this.columnStore) as ROW_TYPE
}
@imemo get lastRow(): ROW_TYPE {
return makeRowFromColumnStore(
this.numRows - 1,
this.columnStore
) as ROW_TYPE
}
@imemo get numRows(): number {
const firstColValues = Object.values(this.columnStore)[0]
return firstColValues ? firstColValues.length : 0
}
@imemo get numColumns(): number {
return this.columnSlugs.length
}
get(columnSlug: ColumnSlug | undefined): CoreColumn {
if (columnSlug === undefined)
return new MissingColumn(this, {
slug: `undefined_slug`,
})
return (
this._columns.get(columnSlug) ??
new MissingColumn(this, {
slug: columnSlug,
})
)
}
has(columnSlug: ColumnSlug | undefined): boolean {
if (columnSlug === undefined) return false
return this._columns.has(columnSlug)
}
getFirstColumnWithType(
columnTypeName: ColumnTypeNames
): CoreColumn | undefined {
return this.columnsAsArray.find(
(col) => col.def.type === columnTypeName
)
}
// todo: move this. time methods should not be in CoreTable, in OwidTable instead (which is really TimeSeriesTable).
// TODO: remove this. Currently we use this to get the right day/year time formatting. For now a chart is either a "day chart" or a "year chart".
// But we can have charts with multiple time columns. Ideally each place that needs access to the timeColumn, would get the specific column
// and not the first time column from the table.
@imemo get timeColumn(): CoreColumn {
// "time" is the canonical time column slug.
// See LegacyToOwidTable where this column is injected for all Graphers.
const maybeTimeColumn = this.get(OwidTableSlugs.time)
if (maybeTimeColumn instanceof ColumnTypeMap.Time)
return maybeTimeColumn
// If a valid "time" column doesn't exist, find _some_ time column to use.
// This is somewhat unreliable and currently only used to infer the time
// column on explorers.
return (
this.columnsAsArray.find(
(col) => col instanceof ColumnTypeMap.Day
) ??
this.columnsAsArray.find(
(col) => col instanceof ColumnTypeMap.Date
) ??
this.columnsAsArray.find(
(col) => col instanceof ColumnTypeMap.Year
) ??
this.columnsAsArray.find(
(col) => col instanceof ColumnTypeMap.Quarter
) ??
maybeTimeColumn
)
}
// todo: should be on owidtable
@imemo get entityNameColumn(): CoreColumn {
return (
this.getFirstColumnWithType(ColumnTypeNames.EntityName) ??
this.get(OwidTableSlugs.entityName)
)
}
// todo: should be on owidtable
@imemo get entityNameSlug(): string {
return this.entityNameColumn.slug
}
// Todo: remove this. Generally this should not be called until the data is loaded. Even then, all calls should probably be made
// on the column itself, and not tied tightly to the idea of a time column.
@imemo get timeColumnFormatFunction(): (year: number) => string {
return !this.timeColumn.isMissing
? this.timeColumn.formatValue
: formatYear
}
formatTime(value: any): string {
return this.timeColumnFormatFunction(value)
}
@imemo private get columnsWithParseErrors(): CoreColumn[] {
return this.columnsAsArray.filter((col) => col.numErrorValues)
}
@imemo get numColumnsWithErrorValues(): number {
return this.columnsWithParseErrors.length
}
@imemo get numErrorValues(): number {
return sum(this.columnsAsArray.map((col) => col.numErrorValues))
}
@imemo get numValidCells(): number {
return sum(this.columnsAsArray.map((col) => col.numValues))
}
get rootTable(): this {
return this.parent ? this.parent.rootTable : this
}
/**
* Returns a string map (aka index) where the keys are the combined string values of columnSlug[], and the values
* are the indices for the rows that match.
*
* {country: "USA", population: 100}
*
* So `table.rowIndex(["country", "population"]).get("USA 100")` would return [0].
*
*/
rowIndex(columnSlugs: ColumnSlug[]): Map<string, number[]> {
const index = new Map<string, number[]>()
const keyFn = makeKeyFn(this.columnStore, columnSlugs)
this.indices.forEach((rowIndex) => {
// todo: be smarter for string keys
const key = keyFn(rowIndex)
if (!index.has(key)) index.set(key, [])
index.get(key)!.push(rowIndex)
})
return index
}
/**
* Returns a map (aka index) where the keys are the values of the indexColumnSlug, and the values
* are the values of the valueColumnSlug.
*
* {country: "USA", population: 100}
*
* So `table.valueIndex("country", "population").get("USA")` would return 100.
*
*/
protected valueIndex(
indexColumnSlug: ColumnSlug,
valueColumnSlug: ColumnSlug
): Map<PrimitiveType, PrimitiveType> {
const indexCol = this.get(indexColumnSlug)
const valueCol = this.get(valueColumnSlug)
const indexValues = indexCol.valuesIncludingErrorValues
const valueValues = valueCol.valuesIncludingErrorValues
const valueIndices = new Set(valueCol.validRowIndices)
const intersection = indexCol.validRowIndices.filter((index) =>
valueIndices.has(index)
)
const map = new Map<PrimitiveType, PrimitiveType>()
intersection.forEach((index) => {
map.set(
indexValues[index] as PrimitiveType,
valueValues[index] as PrimitiveType
)
})
return map
}
grep(searchStringOrRegex: string | RegExp): this {
return this.rowFilter((row) => {
const line = Object.values(row).join(" ")
return typeof searchStringOrRegex === "string"
? line.includes(searchStringOrRegex)
: searchStringOrRegex.test(line)
}, `Kept rows that matched '${searchStringOrRegex.toString()}'`)
}
get opposite(): this {
const { parent } = this
const { filterMask } = this.advancedOptions
if (!filterMask || !parent) return this
return this.transform(
parent.columnStore,
this.defs,
`Inversing previous filter`,
TransformType.InverseFilterRows,
filterMask.inverse()
)
}
@imemo get oppositeColumns(): this {
if (this.isRoot) return this
const columnsToDrop = new Set(this.columnSlugs)
const defs = this.parent!.columnsAsArray.filter(
(col) => !columnsToDrop.has(col.slug)
).map((col) => col.def) as COL_DEF_TYPE[]
return this.transform(
this.columnStore,
defs,
`Inversing previous column filter`,
TransformType.InverseFilterColumns
)
}
grepColumns(searchStringOrRegex: string | RegExp): this {
const columnsToDrop = this.columnSlugs.filter((slug) => {
return typeof searchStringOrRegex === "string"
? !slug.includes(searchStringOrRegex)
: !searchStringOrRegex.test(slug)
})
return this.dropColumns(
columnsToDrop,
`Kept ${
this.columnSlugs.length - columnsToDrop.length
} columns that matched '${searchStringOrRegex.toString()}'.`
)
}
rowFilter(
predicate: (row: ROW_TYPE, index: number) => boolean,
opName: string
): this {
return this.transform(
this.columnStore,
this.defs,
opName,
TransformType.FilterRows,
new FilterMask(this.numRows, this.rows.map(predicate)) // Warning: this will be slow
)
}
columnFilter(
columnSlug: ColumnSlug,
predicate: (value: CoreValueType, index: number) => boolean,
opName: string
): this {
return this.transform(
this.columnStore,
this.defs,
opName,
TransformType.FilterRows,
new FilterMask(
this.numRows,
this.get(columnSlug).valuesIncludingErrorValues.map(predicate)
)
)
}
sortBy(slugs: ColumnSlug[]): this {
return this.transform(
sortColumnStore(this.columnStore, slugs),
this.defs,
`Sort by ${slugs.join(",")}`,
TransformType.SortRows
)
}
sortColumns(slugs: ColumnSlug[]): this {
const first = this.getColumns(slugs)
const rest = this.columnsAsArray.filter((col) => !first.includes(col))
return this.transform(
this.columnStore,
[...first, ...rest].map((col) => col.def as COL_DEF_TYPE),
`Sorted columns`,
TransformType.SortColumns
)
}
reverse(): this {
return this.transform(
reverseColumnStore(this.columnStore),
this.defs,
`Reversed row order`,
TransformType.SortRows
)
}
// Assumes table is sorted by columnSlug. Returns an array representing the starting index of each new group.
protected groupBoundaries(columnSlug: ColumnSlug): number[] {
const values = this.get(columnSlug).valuesIncludingErrorValues
const arr: number[] = []
let last: CoreValueType
this.get(columnSlug).valuesIncludingErrorValues.forEach(
(val, index) => {
if (val !== last) {
arr.push(index)
last = val
}
}
)
// Include the end of the last group, which doesn't result in a change in value above.
if (values && values.length) {
arr.push(values.length)
}
return arr
}
@imemo get defs(): COL_DEF_TYPE[] {
return this.columnsAsArray.map((col) => col.def) as COL_DEF_TYPE[]
}
@imemo get columnNames(): string[] {
return this.columnsAsArray.map((col) => col.name)
}
@imemo get columnTypes(): (ColumnTypeNames | undefined)[] {
return this.columnsAsArray.map((col) => col.def.type)
}
@imemo get columnJsTypes(): JsTypes[] {
return this.columnsAsArray.map((col) => col.jsType)
}
@imemo get columnSlugs(): string[] {
return Array.from(this._columns.keys())
}
@imemo get numericColumnSlugs(): string[] {
return this._numericColumnSlugs
}
private get _numericColumnSlugs(): string[] {
return this._columnsAsArray
.filter((col) => col instanceof ColumnTypeMap.Numeric)
.map((col) => col.slug)
}
private get _columnsAsArray(): CoreColumn[] {
return Array.from(this._columns.values())
}
@imemo get columnsAsArray(): CoreColumn[] {
return this._columnsAsArray
}
getColumns(slugs: ColumnSlug[]): CoreColumn[] {
return slugs.map((slug) => this.get(slug))
}
// Get the min and max for multiple columns at once
domainFor(slugs: ColumnSlug[]): ValueRange {
const cols = this.getColumns(slugs)
const mins = cols.map((col) => col.minValue)
const maxes = cols.map((col) => col.maxValue)
return [min(mins), max(maxes)]
}
private extract(slugs = this.columnSlugs): any[][] {
return this.rows.map((row) =>
slugs.map((slug) =>
isNotErrorValue(row[slug]) ? row[slug] : undefined
)
)
}
private get isRoot(): boolean {
return !this.parent
}
dump(rowLimit = 30): void {
this.dumpPipeline()
this.dumpColumns()
this.dumpRows(rowLimit)
}
dumpPipeline(): void {
// eslint-disable-next-line no-console
console.table(this.ancestors.map((tb) => tb.explanation))
}
dumpColumns(): void {
// eslint-disable-next-line no-console
console.table(this.explainColumns)
}
rowsFrom(start: number, end: number): any {
if (start >= this.numRows) return []
if (end > this.numRows) end = this.numRows
return range(start, end).map((index) =>
makeRowFromColumnStore(index, this.columnStore)
)
}
dumpRows(rowLimit = 30): void {
// eslint-disable-next-line no-console
console.table(this.rowsFrom(0, rowLimit), this.columnSlugs)
}
dumpInputTable(): void {
// eslint-disable-next-line no-console
console.table(this.inputAsTable)
}
@imemo private get inputType(): InputType {
const { originalInput } = this
if (typeof originalInput === "string") return InputType.Delimited
if (Array.isArray(originalInput))
return Array.isArray(originalInput[0])
? InputType.Matrix
: InputType.RowStore
return InputType.ColumnStore
}
@imemo private get inputColumnStoreToRows(): Record<
string,
CoreValueType
>[] {
return columnStoreToRows(this.inputColumnStore)
}
@imemo private get inputAsTable() {
const { inputType } = this
return inputType === InputType.ColumnStore
? this.inputColumnStoreToRows
: inputType === InputType.Matrix
? rowsFromMatrix(this.originalInput as CoreMatrix)
: this.originalInput
}
@imemo private get explainColumns() {
return this.columnsAsArray.map((col) => {
const {
slug,
jsType,
name,
numValues,
numErrorValues,
displayName,
def,
} = col
return {
slug,
type: def.type,
jsType,
name,
numValues,
numErrorValues,
displayName,
color: def.color,
}
})
}
get ancestors(): this[] {
return this.parent ? [...this.parent.ancestors, this] : [this]
}
@imemo private get numColsToParse(): number {
return this.colsToParse.length
}
private static guids = 0
private guid = ++CoreTable.guids
private get explanation() {
// todo: is there a better way to do this in JS?
const {
tableDescription,
transformCategory,
guid,
numColumns,
numRows,
betweenTime,
timeToLoad,
numColsToParse,
numValidCells,
numErrorValues,
numColumnsWithErrorValues,
} = this
return {
tableDescription: truncate(tableDescription, 40),
transformCategory,
guid,
numColumns,
numRows,
betweenTime,
timeToLoad,
numColsToParse,
numValidCells,
numErrorValues,
numColumnsWithErrorValues,
}
}
// Output a pretty table for consles
toAlignedTextTable(options?: AlignedTextTableOptions): string {
return toAlignedTextTable(this.columnSlugs, this.rows, options)
}
toMarkdownTable(): string {
return toMarkdownTable(this.columnSlugs, this.rows)
}
toDelimited(
delimiter: string = ",",
columnSlugs = this.columnSlugs,
rows = this.rows
): string {
return toDelimited(delimiter, columnSlugs, rows)
}
toTsv(): string {
return this.toDelimited("\t")
}
toCsvWithColumnNames(): string {
const delimiter = ","
const header =
this.columnsAsArray
.map((col) => csvEscape(col.name))
.join(delimiter) + "\n"
const body = this.rows
.map((row) =>
this.columnsAsArray.map(
(col) => col.formatForCsv(row[col.slug]) ?? ""
)
)
.map((row) => row.join(delimiter))
.join("\n")
return header + body
}
// Get all the columns that only have 1 value
get constantColumns(): CoreColumn[] {
return this.columnsAsArray.filter((col) => col.isConstant)
}
rowsAt(indices: number[]): ROW_TYPE[] {
const { columnStore } = this
return indices.map(
(index) => makeRowFromColumnStore(index, columnStore) as ROW_TYPE
)
}
findRows(query: CoreQuery): ROW_TYPE[] {
return this.rowsAt(this.findRowsIndices(query))
}
findRowsIndices(query: CoreQuery): any {
const slugs = Object.keys(query)
if (!slugs.length) return this.indices
const arrs = this.getColumns(slugs).map((col) =>
col.indicesWhere(query[col.slug])
)
return intersection(...arrs)
}
indexOf(row: ROW_TYPE): any {
return this.findRowsIndices(row)[0] ?? -1
}
where(query: CoreQuery): this {
const rows = this.findRows(query)
const queryDescription = Object.entries(query)
.map(([col, value]) => `${col}=${value}`)
.join("&")
return this.transform(
rows,
this.defs,
`Selecting ${rows.length} rows where ${queryDescription}`,
TransformType.FilterRows
)
}
appendRows(rows: ROW_TYPE[], opDescription: string): this {
return this.concat(
[new (this.constructor as any)(rows, this.defs) as CoreTable],
opDescription
)
}
limit(howMany: number, offset: number = 0): this {
const start = offset
const end = offset + howMany
return this.transform(
this.columnStore,
this.defs,
`Kept ${howMany} rows starting at ${offset}`,
TransformType.FilterRows,
new FilterMask(
this.numRows,
this.indices.map((index) => index >= start && index < end)
)
)
}
updateDefs(fn: (def: COL_DEF_TYPE) => COL_DEF_TYPE): this {
return this.transform(
this.columnStore,
this.defs.map(fn),
`Updated column defs`,
TransformType.UpdateColumnDefs
)
}
limitColumns(howMany: number, offset: number = 0): this {
const slugs = this.columnSlugs.slice(offset, howMany + offset)
return this.dropColumns(
slugs,
`Kept ${howMany} columns and dropped '${slugs}'`
)
}
select(slugs: ColumnSlug[]): this {
const columnsToKeep = new Set(slugs)
const newStore: CoreColumnStore = {}
const defs = this.columnsAsArray
.filter((col) => columnsToKeep.has(col.slug))
.map((col) => col.def) as COL_DEF_TYPE[]
Object.keys(this.columnStore)
.filter((slug) => columnsToKeep.has(slug))
.forEach((slug) => {
newStore[slug] = this.columnStore[slug]
})
return this.transform(
newStore,
defs,
`Kept columns '${slugs}'`,
TransformType.FilterColumns
)
}
dropColumns(slugs: ColumnSlug[], message?: string): this {
const columnsToDrop = new Set(slugs)
const newStore = {
...this.columnStore,
}
const defs = this.columnsAsArray
.filter((col) => !columnsToDrop.has(col.slug))
.map((col) => col.def) as COL_DEF_TYPE[]
slugs.forEach((slug) => {
delete newStore[slug]
})
return this.transform(
newStore,
defs,
message ?? `Dropped columns '${slugs}'`,
TransformType.FilterColumns
)
}
@imemo get duplicateRowIndices(): number[] {
const keyFn = makeKeyFn(this.columnStore, this.columnSlugs)
const dupeSet = new Set()
const dupeIndices: number[] = []
this.indices.forEach((rowIndex) => {
const key = keyFn(rowIndex)
if (dupeSet.has(key)) dupeIndices.push(rowIndex)
else dupeSet.add(key)
})
return dupeIndices
}
dropDuplicateRows(): this {
return this.dropRowsAt(this.duplicateRowIndices)
}
isRowEmpty(index: number): boolean {
const { columnStore } = this
return (
this.columnSlugs
.map((slug) => columnStore[slug][index])
.filter((value) => isNotErrorValue(value) && value !== "")
.length === 0
)
}
dropEmptyRows(): this {
return this.dropRowsAt(
this.indices
.map((index) => (this.isRowEmpty(index) ? index : null))
.filter(isPresent)
)
}
renameColumn(oldSlug: ColumnSlug, newSlug: ColumnSlug): this {
return this.renameColumns({ [oldSlug]: newSlug })
}
// Todo: improve typings. After renaming a column the row interface should change. Applies to some other methods as well.
renameColumns(columnRenameMap: { [columnSlug: string]: ColumnSlug }): this {
const oldSlugs = Object.keys(columnRenameMap)
const newSlugs = Object.values(columnRenameMap)
const message =
`Renamed ` +
oldSlugs
.map((name, index) => `'${name}' to '${newSlugs[index]}'`)
.join(" and ")
return this.transform(
renameColumnStore(this.columnStore, columnRenameMap),
this.defs.map((def) =>
oldSlugs.indexOf(def.slug) > -1
? {
...def,
slug: newSlugs[oldSlugs.indexOf(def.slug)],
}
: def
),
message,
TransformType.RenameColumns
)
}
dropRowsAt(indices: number[], message?: string): this {
return this.transform(
this.columnStore,
this.defs,
message ?? `Dropping ${indices.length} rows`,
TransformType.FilterRows,
new FilterMask(this.numRows, indices, false)
)
}
// for testing. Preserves ordering.
dropRandomRows(howMany: number = 1, seed: number = Date.now()): this {
if (!howMany) return this // todo: clone?
const indexesToDrop = getDropIndexes(this.numRows, howMany, seed)
return this.dropRowsAt(
Array.from(indexesToDrop.values()),
`Dropping a random ${howMany} rows`
)
}
replaceNonPositiveCellsForLogScale(columnSlugs: ColumnSlug[] = []): this {
return this.transform(
replaceCells(this.columnStore, columnSlugs, (val) =>
val <= 0 ? ErrorValueTypes.InvalidOnALogScale : val
),
this.defs,
`Replaced negative or zero cells across columns ${columnSlugs.join(
" and "
)}`,
TransformType.UpdateRows
)
}
replaceNonNumericCellsWithErrorValues(columnSlugs: ColumnSlug[]): this {
return this.transform(
replaceCells(this.columnStore, columnSlugs, (val) =>
!isNumber(val) ? ErrorValueTypes.NaNButShouldBeNumber : val
),
this.defs,
`Replaced non-numeric cells across columns ${columnSlugs.join(
", "
)}`,
TransformType.UpdateRows
)
}
replaceRandomCells(
howMany = 1,
columnSlugs: ColumnSlug[] = [],
seed = Date.now(),
replacementGenerator: () => any = (): DroppedForTesting =>
ErrorValueTypes.DroppedForTesting
): this {
return this.transform(
replaceRandomCellsInColumnStore(
this.columnStore,
howMany,
columnSlugs,
seed,
replacementGenerator
),
this.defs,
`Replaced a random ${howMany} cells in ${columnSlugs.join(
" and "
)}`,
TransformType.UpdateRows
)
}
dropRandomPercent(
dropHowMuch: number = 1,
seed: number = Date.now()
): this {
return this.dropRandomRows(
Math.floor((dropHowMuch / 100) * this.numRows),
seed
)
}
isGreaterThan(
columnSlug: ColumnSlug,
value: PrimitiveType,
opName?: string
): this {
return this.columnFilter(
columnSlug,
(colValue) => colValue > value,
opName ?? `Filter where ${columnSlug} > ${value}`
)
}
filterNegativesForLogScale(columnSlug: ColumnSlug): this {
return this.isGreaterThan(
columnSlug,
0,
`Remove rows if ${columnSlug} is <= 0 for log scale`
)
}
filterNegatives(slug: ColumnSlug): this {
return this.columnFilter(
slug,
(value) => value >= 0,
`Filter negative values for ${slug}`
)
}
appendColumns(defs: COL_DEF_TYPE[]): this {
return this.transform(
this.columnStore,
this.defs.concat(defs),
`Appended columns ${defs
.map((def) => `'${def.slug}'`)
.join(" and ")}`,
TransformType.AppendColumns
)
}
duplicateColumn(slug: ColumnSlug, overrides: COL_DEF_TYPE): this {
return this.transform(
{
...this.columnStore,
[overrides.slug]: this.columnStore[slug],
},
this.defs.concat([
{
...this.get(slug).def,
...overrides,
},
]),
`Duplicated column '${slug}' to column '${overrides.slug}'`,
TransformType.AppendColumns
)
}
transpose(
by: ColumnSlug,
columnTypeNameForNewColumns = ColumnTypeNames.Numeric
): this {
const newColumnSlugs = [by, ...this.get(by).uniqValues]
const newColumnDefs = newColumnSlugs.map((slug) => {
if (slug === by) return { slug }
return {
type: columnTypeNameForNewColumns,
slug,
}
}) as COL_DEF_TYPE[]
const newRowValues = this.columnsAsArray
.filter((col) => col.slug !== by)
.map((col) => [col.slug, ...col.valuesIncludingErrorValues])
return this.transform(
[newColumnSlugs, ...newRowValues],
newColumnDefs,
`Transposed`,
TransformType.Transpose
)
}
columnIntersection(tables: CoreTable[]): string[] {
return intersection(
this.columnSlugs,
...tables.map((table) => table.columnSlugs)
)
}
private intersectingRowIndices(tables: CoreTable[]): number[] {
const columnSlugs = this.columnIntersection(tables)
if (!columnSlugs.length) return []
const thisIndex = this.rowIndex(columnSlugs)
const indices = [
thisIndex,
...tables.map((table) => table.rowIndex(columnSlugs)),
]
const keys = intersectionOfSets(
indices.map((index) => new Set(index.keys()))
)
return Array.from(keys).map((key) => thisIndex.get(key)![0]) // Only include first match if many b/c we are treating tables as sets here
}
intersection(tables: CoreTable[]): this {
return this.transform(
this.columnStore,
this.defs,
`Keeping only rows also in all tables`,
TransformType.FilterRows,
new FilterMask(
this.numRows,
this.intersectingRowIndices(tables),
true
)
)
}
difference(tables: CoreTable[]): this {
return this.transform(
this.columnStore,
this.defs,
`Keeping only rows not in all other tables`,
TransformType.FilterRows,
new FilterMask(
this.numRows,
this.intersectingRowIndices(tables),
false
)
)
}
appendColumnsIfNew(defs: COL_DEF_TYPE[]): this {
return this.appendColumns(defs.filter((def) => !this.has(def.slug)))
}
toMatrix(): any[][] {
const slugs = this.columnSlugs
const rows = this.rows.map((row) =>
slugs.map((slug) =>
isNotErrorValue(row[slug]) ? row[slug] : undefined
)
)
return [this.columnSlugs, ...rows]
}
// Same as toMatrix, but preserves error types
toTypedMatrix(): any[][] {
const slugs = this.columnSlugs
const rows = this.rows.map((row) => slugs.map((slug) => row[slug]))
return [this.columnSlugs, ...rows]
}
defToObject(): any {
const output: any = {}
this.columnsAsArray.forEach((col) => {
output[col.slug] = col.def
})
return output
}
toJs(): { columns: any; rows: ROW_TYPE[] } {
return {
columns: this.defToObject(),
rows: this.rows,
}
}
private join(
destinationTable: CoreTable,
sourceTable: CoreTable,
by?: ColumnSlug[]
): COL_DEF_TYPE[] {
by =
by ??
intersection(sourceTable.columnSlugs, destinationTable.columnSlugs)
const columnSlugsToAdd = difference(
sourceTable.columnSlugs,
destinationTable.columnSlugs
)
const defsToAdd = sourceTable
.getColumns(columnSlugsToAdd)
.map((col) => {
const def = { ...col.def }
def.values = []
return def
}) as COL_DEF_TYPE[]
const rightIndex = sourceTable.rowIndex(by)
const sourceColumns = sourceTable.columnStore
const keyFn = makeKeyFn(destinationTable.columnStore, by)
destinationTable.indices.forEach((rowIndex) => {
const matchingRightRowIndex = rightIndex.get(keyFn(rowIndex))
defsToAdd.forEach((def) => {
if (matchingRightRowIndex !== undefined)
def.values?.push(
sourceColumns[def.slug][matchingRightRowIndex[0]]
)
// todo: use first or last match?
else
def.values?.push(
ErrorValueTypes.NoMatchingValueAfterJoin as any
)
})
})
return defsToAdd
}
concat(tables: CoreTable[], message: string = `Combined tables`): this {
const all = [this, ...tables] as CoreTable[]
const defs = flatten(all.map((table) => table.defs)) as COL_DEF_TYPE[]
const uniqDefs = uniqBy(defs, (def) => def.slug)
return this.transform(
concatColumnStores(
all.map((table) => table.columnStore),
uniqDefs.map((def) => def.slug)
),
uniqDefs,
message,
TransformType.Concat
)
}
/**
* Ensure a row exists for all values in columnSlug1 × columnSlug2 × ...
*
* For example, if we have a table:
*
* ```
* entityName, year, …
* UK, 2000, …
* UK, 2005, …
* USA, 2003, …
* ```
*
* After `complete(["entityName", "year"])`, we'd get:
*
* ```
* entityName, year, …
* UK, 2000, …
* UK, 2003, …
* UK, 2005, …
* USA, 2000, …
* USA, 2003, …
* USA, 2005, …
* ```
*
*/
complete(columnSlugs: ColumnSlug[]): this {
const index = this.rowIndex(columnSlugs)
const cols = this.getColumns(columnSlugs)
const product = cartesianProduct(...cols.map((col) => col.uniqValues))
const toAdd = product.filter((row) => !index.has(row.join(" ")))
return this.appendRows(
rowsFromMatrix([columnSlugs, ...toAdd]),
`Append missing combos of ${columnSlugs}`
)
}
leftJoin(rightTable: CoreTable, by?: ColumnSlug[]): this {
return this.appendColumns(this.join(this, rightTable, by))
}
rightJoin(rightTable: CoreTable, by?: ColumnSlug[]): this {
return rightTable.leftJoin(this, by) as any // todo: change parent?
}
innerJoin(rightTable: CoreTable, by?: ColumnSlug[]): this {
const defs = this.join(this, rightTable, by)
const newValues = defs.map((def) => def.values)
const rowsToDrop: number[] = []
newValues.forEach((col) => {
col?.forEach((value, index) => {
if ((value as any) === ErrorValueTypes.NoMatchingValueAfterJoin)
rowsToDrop.push(index)
})
})
return this.appendColumns(defs).dropRowsAt(rowsToDrop)
}
fullJoin(rightTable: CoreTable, by?: ColumnSlug[]): this {
return this.leftJoin(rightTable, by)
.concat([rightTable.leftJoin(this, by)])
.dropDuplicateRows()
}
union(tables: CoreTable[]): this {
return this.concat(tables).dropDuplicateRows()
}
indexBy(slug: ColumnSlug): Map<CoreValueType, number[]> {
const map = new Map<CoreValueType, number[]>()
this.get(slug).values.map((value, index) => {
if (!map.has(value)) map.set(value, [])
map.get(value)!.push(index)
})
return map
}
groupBy(by: ColumnSlug): this[] {
const index = this.indexBy(by)
return Array.from(index.keys()).map((groupName) =>
this.transform(
this.columnStore,
this.defs,
`Rows for group ${groupName}`,
TransformType.FilterRows,
new FilterMask(this.numRows, index.get(groupName)!)
)
)
}
reduce(reductionMap: ReductionMap): this {
const lastRow = { ...this.lastRow }
Object.keys(reductionMap).forEach((slug: keyof ROW_TYPE) => {
const prop = reductionMap[slug]
const col = this.get(slug)
if (typeof prop === "string") lastRow[slug] = col[prop]
else lastRow[slug] = prop(col) as any
})
return this.transform(
rowsToColumnStore([lastRow]),
this.defs,
`Reduced table`,
TransformType.Reduce
)
}
}
interface ReductionMap {
[columnSlug: string]:
| ReductionTypes
| ((column: CoreColumn) => CoreValueType)
}
type ReductionTypes = keyof CoreColumn
class FilterMask {
private mask: boolean[]
private numRows: number
constructor(
numRows: number,
input: boolean[] | number[],
keepThese = true
) {
this.numRows = numRows
if (typeof input[0] === "boolean") this.mask = input as boolean[]
else {
const set = new Set(input as number[])
this.mask = range(0, numRows).map((index) =>
set.has(index) ? keepThese : !keepThese
)
}
}
inverse(): FilterMask {
return new FilterMask(
this.numRows,
this.mask.map((bit) => !bit)
)
}
apply(columnStore: CoreColumnStore): CoreColumnStore {
const columnsObject: CoreColumnStore = {}
Object.keys(columnStore).forEach((slug) => {
columnsObject[slug] = columnStore[slug].filter(
(slug, index) => this.mask[index]
)
})
return columnsObject
}
}
/**
* Allows you to store your column definitions in CSV/TSV like:
* slug,name,type etc.
*
* todo: define all column def property types
*/
export const columnDefinitionsFromDelimited = <T>(delimited: string): T[] =>
new CoreTable<T>(delimited.trim()).columnFilter(
"slug",
(value) => !!value,
"Keep only column defs with a slug"
).rows
|