Reference API
Alex Wu's utility functions for data processing, visualization, and reporting.
Metadata | Description |
---|---|
Author | Alexander Wu |
alexander.wu7@gmail.com | |
Date Modified | August 2023 |
DF(*args, **kwargs)
Create PyArrow Pandas DataFrame.
Returns:
Type | Description |
---|---|
pd.Series
|
pd.DataFrame: pd.DataFrame with pyarrow data types |
Source code in alexwu/alexwu.py
134 135 136 137 138 139 140 141 |
|
S(*args, **kwargs)
Create PyArrow Pandas Series.
Returns:
Type | Description |
---|---|
pd.Series
|
pd.Series: pd.Series with pyarrow data types |
Source code in alexwu/alexwu.py
125 126 127 128 129 130 131 132 |
|
add_prefix(df, prefix, subset=None, regex=None)
Add prefix to columns
Parameters:
Name | Type | Description | Default |
---|---|---|---|
df |
pd.DataFrame
|
Input dataframe |
required |
prefix |
str
|
prefix string to prepend |
required |
subset |
_type_
|
subset of columns to affect. Defaults to None. |
None
|
regex |
_type_
|
regex filter of columns to affect. Defaults to None. |
None
|
Returns:
Type | Description |
---|---|
pd.DataFrame
|
pd.DataFrame: Transformed dataframe with certain columns prepended with prefix |
Source code in alexwu/alexwu.py
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
add_suffix(df, suffix, subset=None, regex=None)
Add suffix to columns
Parameters:
Name | Type | Description | Default |
---|---|---|---|
df |
pd.DataFrame
|
Input dataframe |
required |
suffix |
str
|
suffix string to append |
required |
subset |
_type_
|
subset of columns to affect. Defaults to None. |
None
|
regex |
_type_
|
regex filter of columns to affect. Defaults to None. |
None
|
Returns:
Type | Description |
---|---|
pd.DataFrame
|
pd.DataFrame: Transformed dataframe with certain columns appended with suffix |
Source code in alexwu/alexwu.py
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
|
combo_sizes(set_list, set_names=None, vmax=None, sort=True)
Summarary table of set combinations sizes. Rows represent size of overlapping sets
Parameters:
Name | Type | Description | Default |
---|---|---|---|
set_list |
list[set]
|
inputs sets |
required |
set_names |
_type_
|
Names corresponding to input sets. Defaults to None. |
None
|
vmax |
_type_
|
Denominator for percentage. Defaults to # unique elements among all sets in set_list. |
None
|
sort |
bool
|
Sort overlap percentages. Defaults to True. |
True
|
Returns:
Type | Description |
---|---|
pd.DataFrame
|
pd.DataFrame: size of overlapping sets |
Source code in alexwu/alexwu.py
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 |
|
combo_sizes2(set_list, set_names=None, vmax=None, sort=True)
Summarary table of set combinations sizes (strict).
Rows represent size of overlapping sets only(which don't containing others).
Parameters:
Name | Type | Description | Default |
---|---|---|---|
set_list |
list[set]
|
inputs sets |
required |
set_names |
_type_
|
Names corresponding to input sets. Defaults to None. |
None
|
vmax |
_type_
|
Denominator for percentage. Defaults to # unique elements among all sets in set_list. |
None
|
sort |
bool
|
Sort overlap percentages. Defaults to True. |
True
|
Returns:
Type | Description |
---|---|
pd.DataFrame
|
pd.DataFrame: size of overlapping sets (strict) |
Source code in alexwu/alexwu.py
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 |
|
copy(text)
Copy text to clipboard.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
text |
str
|
text to copy to clipboard |
required |
Source code in alexwu/alexwu.py
183 184 185 186 187 188 189 190 191 192 193 194 |
|
date2name(pd_series)
Convert to date to day of week.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
pd_series |
pd.Series
|
Input datetimes |
required |
Returns:
Type | Description |
---|---|
pd.Series
|
pd.Series: Day of week names |
Source code in alexwu/alexwu.py
220 221 222 223 224 225 226 227 228 229 230 231 |
|
df_overlaps(df1, df2, suffixes=('1', '2'))
Merge based on overlapping 'start', 'end' variables
Parameters:
Name | Type | Description | Default |
---|---|---|---|
df1 |
pd.DataFrame
|
Input dataframe 1 |
required |
df2 |
pd.DataFrame
|
Input dataframe 2 |
required |
suffixes |
tuple
|
identify corresponding columns with this suffix. Defaults to ('1', '2'). |
('1', '2')
|
Returns:
Type | Description |
---|---|
pd.DataFrame
|
pd.DataFrame: Merged dataframe (based on corresponding 'start' and 'end' of input dataframes) |
Source code in alexwu/alexwu.py
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 |
|
dirr(arg, like=None)
Displays dir(arg) but with more details and formatted as DataFrame.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
arg |
Any
|
python object |
required |
like |
str
|
filter string. Defaults to None. |
None
|
Source code in alexwu/alexwu.py
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 |
|
disp(df, caption='', k=2, na_rep='-')
(For Jupyter) Prints newlines instead of '\n' characters for easier reading. Optionally, you can label dataframes with caption and round numbers
Parameters:
Name | Type | Description | Default |
---|---|---|---|
df |
pd.DataFrame
|
Input DataFrame |
required |
caption |
str
|
Caption for df. Defaults to ''. |
''
|
k |
int
|
Round to k digits. Defaults to 2. |
2
|
na_rep |
str
|
Str representation of NA values. Defaults to '-'. |
'-'
|
Returns:
Type | Description |
---|---|
pd.DataFrame
|
pd.DataFrame: Styled DataFrame with optional caption |
Source code in alexwu/alexwu.py
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 |
|
display100(df, ii=10, N=100, na_rep=None)
Display N elements with ii elements each column
Parameters:
Name | Type | Description | Default |
---|---|---|---|
df |
pd.Series, pd.DataFrame
|
Input values |
required |
ii |
int
|
elements in column. Defaults to 10. |
10
|
N |
int
|
elements to display. Defaults to 100. |
100
|
na_rep |
_type_
|
Missing str representation. Defaults to None. |
None
|
Source code in alexwu/alexwu.py
597 598 599 600 601 602 603 604 605 606 607 608 609 |
|
displays(*args, captions=None, k=2, na_rep='-')
(For Jupyter)
Display tables side by side to save vertical space.
Prints newlines instead of '
' characters for easier reading. Optionally, you can label dataframes with captions
Input:
args: list of pandas.DataFrame
captions: list of table captions
Source code in alexwu/alexwu.py
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 |
|
get_sessions(pd_series, diff=pd.Timedelta(30, 'min'))
Group elements into "sessions".
Compute groups (sessions) chained together by diff
units. Assumes pd_series is sorted.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
pd_series |
pd.Series
|
Input values |
required |
diff |
_type_
|
Maximum difference between first element and last element. Defaults to pd.Timedelta(30, 'min'). |
pd.Timedelta(30, 'min')
|
Returns:
Type | Description |
---|---|
pd.Series
|
pd.Series: Grouped elements |
Source code in alexwu/alexwu.py
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 |
|
grouper(iterable, n, fillvalue=None)
Collect data into fixed-length chunks or blocks.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
iterable |
Iterable
|
Iterable to group into chunks |
required |
n |
int
|
size of chunks |
required |
fillvalue |
Any
|
Missing elements to fill in. Defaults to None. |
None
|
Returns:
Name | Type | Description |
---|---|---|
Iterable |
Iterable
|
fixed-length chunks or blocks |
Source code in alexwu/alexwu.py
1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 |
|
highlight(df, v, color='DarkSlateGray', subset=None)
summary
Parameters:
Name | Type | Description | Default |
---|---|---|---|
df |
pd.DataFrame
|
description |
required |
v |
Any
|
description |
required |
color |
str
|
description. Defaults to 'DarkSlateGray'. |
'DarkSlateGray'
|
subset |
_type_
|
description. Defaults to None. |
None
|
Returns:
Name | Type | Description |
---|---|---|
_type_ | description |
|
Example usage: |
||
df.pipe(highlight, 1, color='k') |
Source code in alexwu/alexwu.py
877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 |
|
isnotebook()
Detect if code is running in Jupyter Notebook
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
True = code is running in Jupyter Notebook |
Source code in alexwu/alexwu.py
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
|
ls(path='.', resolve=False)
View contents of ls
command as DataFrame.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
Path | str
|
Path name to |
'.'
|
resolve |
bool
|
Resolve to absolute path. Defaults to False. |
False
|
Raises:
Type | Description |
---|---|
ValueError
|
Invalid path name |
Returns:
Type | Description |
---|---|
pd.DataFrame
|
pd.DataFrame: contents of |
Source code in alexwu/alexwu.py
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 |
|
mkdir(path, **kwargs)
Make directory.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
Path | str
|
Directory to create |
required |
Raises:
Type | Description |
---|---|
ValueError
|
Invalid path name |
Source code in alexwu/alexwu.py
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
|
overlaps(x_interval, y_interval)
Compute overlaps. Assumes non_overlapping_monotonic_increasing.
There are 9 ways Y_interval and overlap with X_interval
| XXX | X_interval | ( 3, 5 ) | |
|---------|--------------|------------|---------------------------------------|
| _YY_ | left | (_2 , _4 ) | (x_begin < y_begin) & (x_end < y_end) |
| _YYYY | left_spill | (_2 , 5 ) | (x_begin < y_begin) & (x_end = y_end) |
| _YYYYY_ | superset | (_2 , 6_) | (x_begin < y_begin) & (x_end > y_end) |
| Y_ | left_subset | ( 3 , _4 ) | (x_begin = y_begin) & (x_end < y_end) |
| YYY | equal | ( 3 , 5 ) | (x_begin = y_begin) & (x_end = y_end) |
| YYYY_ | right_spill | ( 3 , 6_) | (x_begin = y_begin) & (x_end > y_end) |
| _ | subset | (_4_, _4_) | (x_begin > y_begin) & (x_end < y_end) |
| _Y | right_subset | (_4 , 5 ) | (x_begin > y_begin) & (x_end = y_end) |
| _YY_ | right | (_4 , 6_) | (x_begin > y_begin) & (x_end > y_end) |
|---------|--------------|------------|---------------------------------------|
| __ | no_overlap | (_2 , 6_) | (x_begin > y_end) |
| __ | no_overlap | (_2 , 6_) | (x_end < y_begin) |
|---------|--------------|------------|---------------------------------------|
| 1234567 | | | |
Source code in alexwu/alexwu.py
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 |
|
pairwise(iterable)
Groups elements pairwise: s -> (s0,s1), (s1,s2), (s2, s3), ...
Parameters:
Name | Type | Description | Default |
---|---|---|---|
iterable |
Iterable
|
Input iterable |
required |
Returns:
Name | Type | Description |
---|---|---|
Iterable |
Iterable
|
zipped iterable |
Source code in alexwu/alexwu.py
584 585 586 587 588 589 590 591 592 593 594 595 |
|
percent(pd_series, caption='', display_false=False)
Display percentage
Parameters:
Name | Type | Description | Default |
---|---|---|---|
pd_series |
pd.Series
|
Input values |
required |
caption |
str
|
Caption. Defaults to ''. |
''
|
display_false |
bool
|
Display percentage of False values. Defaults to False. |
False
|
Returns:
Type | Description |
---|---|
pd.DataFrame
|
pd.DataFrame: Displayed percentage |
Source code in alexwu/alexwu.py
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 |
|
read_file(filename, overwrite=False, base='data', verbose=True, **kwargs)
Read serialized file, caching the result
Parameters:
Name | Type | Description | Default |
---|---|---|---|
filename |
Path | str
|
File to read in |
required |
overwrite |
bool
|
Overwrite cache. Defaults to False. |
False
|
base |
str
|
Base filepath. Defaults to 'data'. |
'data'
|
verbose |
bool
|
Print what's going on. Defaults to True. |
True
|
Returns:
Type | Description |
---|---|
pd.DataFrame
|
pd.DataFrame: Input file as DataFrame |
Source code in alexwu/alexwu.py
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 |
|
reload(copy_clipboard=False)
Prints Jupyter's autoreload magic function.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
copy_clipboard |
bool
|
Copy contents to clipboard (does not work via remote-ssh). Defaults to False. |
False
|
Source code in alexwu/alexwu.py
27 28 29 30 31 32 33 34 35 |
|
report(func, *df_args, compare=False, concat=False, k_list=2, fillna=False, **kwargs)
Report descriptive statistics.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
func |
Callable
|
Function to map |
required |
compare |
bool
|
Compare pairwise dataframes. Defaults to False. |
False
|
concat |
bool
|
Concatenate descriptive columns. Defaults to False. |
False
|
k_list |
int
|
Round to k digits. Defaults to 2. |
2
|
fillna |
bool
|
NA str representation. Defaults to False. |
False
|
Returns:
Type | Description |
---|---|
pd.DataFrame
|
pd.DataFrame: Styled DataFrame(s) |
Source code in alexwu/alexwu.py
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 |
|
report_categorical(pd_series, dropna=True, style=True)
Report descriptive stats of categorical variable.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
pd_series |
pd.Series
|
Input values |
required |
dropna |
bool
|
Drop missing elements. Defaults to True. |
True
|
style |
bool
|
Style output. Defaults to True. |
True
|
Returns:
Name | Type | Description |
---|---|---|
dict |
dict
|
Descriptive stats |
Source code in alexwu/alexwu.py
1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 |
|
report_numerical(pd_series, name='', k=2, proportiontocut=0, fillna=False, N=True)
Report descriptive statis of numerical variable.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
pd_series |
pd.Series
|
Input values |
required |
name |
str
|
Name of variable. Defaults to ''. |
''
|
k |
int
|
round to k digits. Defaults to 2. |
2
|
proportiontocut |
int
|
Trimmed propertion (from 0 to 1). Defaults to 0. |
0
|
fillna |
bool
|
Filled value. Defaults to False. |
False
|
N |
bool
|
Proportion elements complete (i.e. not missing). Defaults to True. |
True
|
Returns:
Name | Type | Description |
---|---|---|
dict |
dict
|
description |
Source code in alexwu/alexwu.py
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 |
|
report_rows(df, cols=None, dropna=False, k=2, proportiontocut=0, fillna=False, style=True)
Report descriptive statistics as a dict.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
df |
pd.DataFrame
|
Input DataFrame |
required |
cols |
str | list[str]
|
column names. Defaults to None. |
None
|
dropna |
bool
|
Whether to drop missing rows. Defaults to False. |
False
|
k |
int
|
Round to k digits. Defaults to 2. |
2
|
proportiontocut |
int
|
Trimmed propertion (from 0 to 1). Defaults to 0. |
0
|
fillna |
bool
|
Filled value. Defaults to False. |
False
|
style |
bool
|
Style dataframe. Defaults to True. |
True
|
Returns:
Name | Type | Description |
---|---|---|
dict |
dict
|
description statistics |
Source code in alexwu/alexwu.py
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 |
|
report_rows_df(df, cols=None, dropna=False, k=2, proportiontocut=0, fillna=False, style=True)
Report descriptive statistics.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
df |
pd.DataFrame
|
Input DataFrame |
required |
cols |
str | list[str]
|
column names. Defaults to None. |
None
|
dropna |
bool
|
Whether to drop missing rows. Defaults to False. |
False
|
k |
int
|
Round to k digits. Defaults to 2. |
2
|
proportiontocut |
int
|
Trimmed propertion (from 0 to 1). Defaults to 0. |
0
|
fillna |
bool
|
Filled value. Defaults to False. |
False
|
style |
bool
|
Style dataframe. Defaults to True. |
True
|
Returns:
Type | Description |
---|---|
pd.DataFrame
|
pd.DataFrame: Descriptive statistics |
Source code in alexwu/alexwu.py
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 |
|
rm_file(filename, base='data', verbose=True)
Remove file
Parameters:
Name | Type | Description | Default |
---|---|---|---|
filename |
Path | str
|
file to remove |
required |
base |
str
|
Base filepath. Defaults to 'data'. |
'data'
|
verbose |
bool
|
Print what's going on. Defaults to True. |
True
|
Raises:
Type | Description |
---|---|
ValueError
|
Invalid filename |
Source code in alexwu/alexwu.py
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 |
|
show(item, hide_docstring=False)
(For Jupyter) Displays function source code or JSON output
Source code in alexwu/alexwu.py
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 |
|
size(num, prefix='', deep=True, verbose=True)
Human readable file size (ex: 123.4 KB)
Source code in alexwu/alexwu.py
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 |
|
str_contains(pd_series, *regex_str_list, **kwargs)
Filters Pandas Series strings using regex patterns from regex_str_list
Parameters
str
Character sequence or regular expression.
bool, default True
If True, case sensitive.
int, default 0 (no flags)
Flags to pass through to the re module, e.g. re.IGNORECASE.
scalar, optional
Fill value for missing values. The default depends on dtype of the
array. For object-dtype, numpy.nan
is used. For StringDtype
,
pandas.NA
is used.
bool, default True
If True, assumes the pat is a regular expression.
If False, treats the pat as a literal string.
Source code in alexwu/alexwu.py
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 |
|
trim(pd_series, proportiontocut=0.05, conservative=True)
Trimmed bottom and top percentiles.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
pd_series |
pd.Series
|
Input values |
required |
proportiontocut |
float
|
Proportion of elements to discard. Defaults to 0.05. |
0.05
|
conservative |
bool
|
Keep bordered element. Defaults to True. |
True
|
Raises:
Type | Description |
---|---|
ValueError
|
Cannot trim more than 50% from bottom and top |
Returns:
Type | Description |
---|---|
pd.Series
|
pd.Series: Trimmed values |
Source code in alexwu/alexwu.py
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 |
|
wrap_series(fn)
Allows Pandas series operations to apply for other input
Source code in alexwu/alexwu.py
143 144 145 146 147 148 149 150 151 152 153 154 |
|
write_file(df, filename, overwrite=False, base='data', verbose=True, **kwargs)
Write serialized file
Parameters:
Name | Type | Description | Default |
---|---|---|---|
df |
pd.DataFrame
|
DataFrame to save to disk |
required |
filename |
Path | str
|
Filename |
required |
overwrite |
bool
|
Overwrite file. Defaults to False. |
False
|
base |
str
|
Base path. Defaults to 'data'. |
'data'
|
verbose |
bool
|
Verbose. Defaults to True. |
True
|
Raises:
Type | Description |
---|---|
ValueError
|
Invalid filename |
ValueError
|
Invalid file type |
Source code in alexwu/alexwu.py
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 |
|