CHANGELOG.rst 13.8 KB
Newer Older
Paul McCarthy's avatar
Paul McCarthy committed
1
2
3
``ukbparse`` changelog
======================

Paul McCarthy's avatar
Paul McCarthy committed
4

Paul McCarthy's avatar
Paul McCarthy committed
5
0.18.0 (Tuesday 23rd April 2019)
Paul McCarthy's avatar
Paul McCarthy committed
6
7
8
--------------------------------


Paul McCarthy's avatar
Paul McCarthy committed
9
10
11
12
13
14
15
16
Added
^^^^^


* New :func:`.icd10.numericToCode` function for converting from a numeric
  ICD10 code representation back to its alphanumeric representation.


Paul McCarthy's avatar
Paul McCarthy committed
17
18
19
20
Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
21
22
23
* The default binarised ICD10 column name format has been changed from
  ``[variable_id][numeric_code]-[visit].0`` to
  ``[variable_id]-[visit].[numeric_code]``.
Paul McCarthy's avatar
Paul McCarthy committed
24
25
26
27
* The ``--non_numeric_file`` will not be created if there are not any
  non-numeric columns.
* The built-in ``fmrib`` configuration now includes verbosity and logging
  settings.
Paul McCarthy's avatar
Paul McCarthy committed
28
29
30
* The :func:`.isSparse` function now returns the reason and value for
  columns which fail the sparsity test.

Paul McCarthy's avatar
Paul McCarthy committed
31
32


Paul McCarthy's avatar
Paul McCarthy committed
33
0.17.0 (Monday 22nd April 2019)
Paul McCarthy's avatar
Paul McCarthy committed
34
35
36
37
38
39
40
41
42
-------------------------------


Added
^^^^^


* New ``--non_numeric_file`` option allows non-numeric columns to be saved to
  a separate file (TSV export only).
Paul McCarthy's avatar
Paul McCarthy committed
43
44
* Built-in ``fmrib.cfg`` configuration file, which can be used via
  ``-cfg fmrib``.
Paul McCarthy's avatar
Paul McCarthy committed
45
46
47
48
49
50
51
52
53


Changed
^^^^^^^


* The file generated by ``--unknown_vars_file`` now includes variables which
  are known, but are not in an existing category, and do not have any cleaning
  or processing rules specified for them.
Paul McCarthy's avatar
Paul McCarthy committed
54
* Built-in categories have been updated.
Paul McCarthy's avatar
Paul McCarthy committed
55
56
57
58
59
60
61
62


Fixed
^^^^^


* A bug in the column names generated for binarised ICD10 categorical codes
  has been fixed. This bug would potentially have resulted in collisions
Paul McCarthy's avatar
Paul McCarthy committed
63
  between column names for different ICD10 codes.
Paul McCarthy's avatar
Paul McCarthy committed
64
65


Paul McCarthy's avatar
Paul McCarthy committed
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
0.16.0 (Friday 22nd March 2019)
-------------------------------


Changed
^^^^^^^


* Full variable and datacoding table files no longer need to be provided -
  ``ukbparse`` uses ``ukbparse/data/field.txt`` and
  ``ukbparse/data/encoding.txt`` files, obtained from the UK Biobank showcase
  website, as the basis for recognising variables and data codings. The
  ``--variable_file``/``-vf`` and ``--datacoding_file``/``-df`` options now
  accept partial table definitions - these will be merged with the built-in
  rules (still stored in ``ukbparse/data/variables_*.tsv`` and
  ``ukbparse/data/datacodings_*.tsv``) when ``ukbparse`` is invoked.


Deprecated
^^^^^^^^^^


* The ``ukbparse_htmlparse``, ``ukbparse_join`` , and
  ``ukbparse_compare_tables`` commands.


Paul McCarthy's avatar
Paul McCarthy committed
92
93
94
95
96
97
Removed
^^^^^^^


* The ``--icd10_file`` command-line option has been removed.

Paul McCarthy's avatar
Paul McCarthy committed
98

Paul McCarthy's avatar
Paul McCarthy committed
99
100
101
102
103
104
105
106
107
108
109
0.15.1 (Thursday 21st March 2019)
---------------------------------


Fixed
^^^^^


* Fixed a bug which arose when using the ``--rename_column`` option.


Paul McCarthy's avatar
Paul McCarthy committed
110
111
0.15.0 (Monday 18th March 2019)
-------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
112
113
114
115
116
117
118
119
120
121
122


Added
^^^^^


* New cleaning function, :func:`.flattenHierarchical`, for use with
  hierarchical variables (e.g. ICD10). The function can be used to replace
  leaf values with parent values.
* New :mod:`.hierarchy` module which contains helper functions and data
  structures for working with hierarchical variables.
Paul McCarthy's avatar
Paul McCarthy committed
123
124
* Definitions for all hierarchical UK Biobank variables are located in the
  ``ukbparse/data/hierarchy/`` directory.
Paul McCarthy's avatar
Paul McCarthy committed
125
126
127
128
129
130
131
132
133
134
135
136


Deprecated
^^^^^^^^^^


* The :func:`.readICD10ConfigFile` function has been replaced with the
  :func:`.loadHierarchyFile` function.
* The :class:`.ICD10Hierarchy` class has been replaced with the
  :class:`.Hierarchy` class .


Paul McCarthy's avatar
Paul McCarthy committed
137
138
139
140
141
142
143
144
0.14.8 (Monday 18th March 2019)
-------------------------------


Fixed
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
145
146
* Fixed an issue with the :func:`.binariseCategorical` processing function
  being applied to ICD10 codes.
Paul McCarthy's avatar
Paul McCarthy committed
147

Paul McCarthy's avatar
Paul McCarthy committed
148
149
150
151
152
153
154
155
156
157
158
159
160

0.14.7 (Sunday 17th March 2019)
-------------------------------


Changed
^^^^^^^


* Changes to default cleaning rules - negative values for integer/categorical
  types are no longer discarded.


Paul McCarthy's avatar
Paul McCarthy committed
161
162
0.14.6 (Saturday 16th March 2019)
---------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
163
164
165
166
167
168
169
170
171


Fixed
^^^^^


* Fixed a ``KeyError`` which was occurring during the child-value replacement
  stage for input files which did not have column names of the form
  ``[variable]-[visit].[instance]``.
Paul McCarthy's avatar
Paul McCarthy committed
172
173
* Fixed some issues introduced by behavioural changes in the
  ``pandas.HDFStore`` class.
Paul McCarthy's avatar
Paul McCarthy committed
174
175


Paul McCarthy's avatar
Paul McCarthy committed
176
177
178
179
180
181
182
183
184
185
186
187
0.14.5 (Thursday 17th January 2019)
-----------------------------------


Fixed
^^^^^


* Implemented a workaround for a `bug <https://bugs.python.org/issue9334>`_ in
  the Python ``argparse`` module.


Paul McCarthy's avatar
Paul McCarthy committed
188
189
190
191
192
193
194
195
196
0.14.4 (Friday 11th January 2019)
---------------------------------


Changed
^^^^^^^


* Updated the default processing rules for variable
Paul McCarthy's avatar
Paul McCarthy committed
197
  [1120-1150](https://biobank.ctsu.ox.ac.uk/crystal/field.cgi?id=1120).
Paul McCarthy's avatar
Paul McCarthy committed
198
199


Paul McCarthy's avatar
Paul McCarthy committed
200
201
202
203
204
205
206
207
208
209
210
211
0.14.3 (Tuesday 8th January 2019)
---------------------------------


Fixed
^^^^^


* Fixed a regression introduced in 0.14.2, where column loading restrictions
  (e.g. ``--variable``) were not being honoured


Paul McCarthy's avatar
Paul McCarthy committed
212
213
214
215
216
217
218
219
0.14.2 (Monday 7th January 2019)
--------------------------------


Fixed
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
220
* Fixed a regression introduced in 0.14.1, where using the ``--variable`` and
Paul McCarthy's avatar
Paul McCarthy committed
221
222
  ``--visit`` options together could cause a crash.

Paul McCarthy's avatar
Paul McCarthy committed
223

Paul McCarthy's avatar
Paul McCarthy committed
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
0.14.1 (Monday 7th January 2019)
--------------------------------


Fixed
^^^^^


* If the index columns for each input file have different names, the output
  index column was unnamed.  It is now given the name of the index column in
  the first input file.
* When the ``--column`` and ``--variable`` options were used together, only
  columns which passed both tests were being loaded. Now, columns which pass
  either test are loaded.


Paul McCarthy's avatar
Paul McCarthy committed
240
241
0.14.0 (Tuesday 25th December 2018)
-----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
242
243
244
245
246
247


Added
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
248
249
* New ``--column`` option, allowing columns to be selected by name/name
  pattern.
Paul McCarthy's avatar
Paul McCarthy committed
250
251
252
253
254
255
256
257
258
259
260
261
* ``ukbparse`` can now be installed from `conda-forge
  <https://anaconda.org/conda-forge/ukbparse>`_.


Changed
^^^^^^^


* The index column in the output file no longer defaults to being named
  ``'eid'``. It defaults to the name of the index in the input file, but
  can still be overridden by the ``--output_id_column`` option.

Paul McCarthy's avatar
Paul McCarthy committed
262
263
264
265
266
267
268
269
270
271
272

Fixed
^^^^^


* Blank lines are now allowed in configuration files (#2)
* Fix to derived column names for ICD10 variables in default processing rules.


0.13.1 (Thursday 20th December 2018)
------------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
273
274
275
276
277
278
279
280
281
282


Added
^^^^^


* Unit test to make sure that ``ukbparse`` crashes if given bad input
  arguments.


Paul McCarthy's avatar
Paul McCarthy committed
283
284
285
286
287
288
289
290
291
292
0.13.0 (Thursday 20th Deember 2018)
-----------------------------------


Added
^^^^^


* New ``--index`` option, allowing the position of the index column in input
  files to be specified.
Paul McCarthy's avatar
Paul McCarthy committed
293
294
* The ``--variable``, ``--subject``, and ``--exclude`` options now accept
  comma-separated lists, in addition to IDs, ID ranges, and text files.
Paul McCarthy's avatar
Paul McCarthy committed
295
296


Paul McCarthy's avatar
Paul McCarthy committed
297
298
299
300
301
302
303
Fixed
^^^^^


* Memory usage estimates in log messages were wrong under Linux.


Paul McCarthy's avatar
Paul McCarthy committed
304
305
306
307
308
309
310
311
312
313
314
0.12.3 (Tuesday 18th December 2018
----------------------------------


Changed
^^^^^^^


* Changes to new :func:`.fileinfo.has_header` function to improve robustness.


Paul McCarthy's avatar
Paul McCarthy committed
315
316
317
318
319
320
321
322
323
324
325
326
0.12.2 (Monday 17th December 2018)
----------------------------------


Changed
^^^^^^^


* Now using a custom implementation of ``csv.Sniffer.has_header``, as the
  standard library version does not handle some scenarios.


Paul McCarthy's avatar
Paul McCarthy committed
327
328
0.12.1 (Saturday 15th December 2018)
------------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347


Added
^^^^^


* Added some instructions for generating your own variable and data coding
  tables to the README.


Changed
^^^^^^^


* The ``ukbparse_demo`` script ensures that the Jupyter ``bash_kernel`` is
  installed.
* The ``ukbparse_compare_tables``, ``ukbparse_htmlparse`` and
  ``ukbparse_join`` scripts print some help documentation when called without
  any arguments.
Paul McCarthy's avatar
Paul McCarthy committed
348
* Added ``lxml`` as a dependency (required by ``beautifulsoup4``).
Paul McCarthy's avatar
Paul McCarthy committed
349
350


Paul McCarthy's avatar
Paul McCarthy committed
351
352
0.12.0 (Tuesday 11th December 2018)
-----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
353
354
355
356
357
358
359
360
361


Added
^^^^^


* The ``join``, ``compare_tables``, and ``htmlparse`` scripts are now
  installed as entry points called ``ukbparse_join``,
  ``ukbparse_compare_tables``, and ``ukbparse_htmlparse``.
Paul McCarthy's avatar
Paul McCarthy committed
362
363
364
* Jupyter notebook, demonstrating most of the features in ``ukbparse``, at
  ``ukbparse/demo/ukbparse_demonstration.ipynb``. You can run the demo via the
  ``ukbparse_demo`` entry point.
Paul McCarthy's avatar
Paul McCarthy committed
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380


Changed
^^^^^^^


* Moved the ``scripts/`` directory into the ``ukbparse/`` directory.
* Improved string representation of process functions.


Fixed
^^^^^


* Fix to configuration file parsing code - ``shlex.split`` is now used instead
  of ``str.split``.
Paul McCarthy's avatar
Paul McCarthy committed
381
382
* Fixed mixed data type issues when merging the data coding and type tables into
  the variable table.
Paul McCarthy's avatar
Paul McCarthy committed
383

Paul McCarthy's avatar
Paul McCarthy committed
384
385
386
387
388
389
390
391
392
393
394
395
396
397

0.11.3 (Monday 10th December 2018)
----------------------------------


Changed
^^^^^^^


* Made the ``vid``, ``visit``, and ``instance`` parameters to the
  :class:`.Column` class optional, to make life easier for custom sniffer
  functions.


Paul McCarthy's avatar
Paul McCarthy committed
398
399
400
401
402
403
404
405
406
407
408
409
410
0.11.2 (Monday 10th December 2018)
----------------------------------


Fixed
^^^^^


* Fixed a bug in the handling of new variable IDs returned by processing
  functions.



Paul McCarthy's avatar
Paul McCarthy committed
411
412
413
414
415
416
417
418
419
420
421
0.11.1 (Monday 10th December 2018)
----------------------------------


Fixed
^^^^^


* Fixed a bug in the :func:`.removeIfSparse` processing function.


Paul McCarthy's avatar
Paul McCarthy committed
422
423
0.11.0 (Monday 10th December 2018)
----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
424
425
426
427
428
429
430
431


Added
^^^^^


* New ``--no_builtins`` option, which causes the built-in variable, data
  coding, type, and category table files to be bypassed.
Paul McCarthy's avatar
Paul McCarthy committed
432
433
434
* New :meth:`.PluginRegistry.get` function for getting a reference to a plugin
  function.
* Cleaning/processing functions are listed in command-line help.
Paul McCarthy's avatar
Paul McCarthy committed
435
436


Paul McCarthy's avatar
Paul McCarthy committed
437
438
439
440
441
442
443
444
445
446
447
448
449
0.10.5 (Saturday 8th December 2018)
-----------------------------------


Changed
^^^^^^^


* The ``minpres`` option to the :func:`.removeIfSparse` processing function
  is ignored if it is specified as an absolute value, and the data set length
  is less than it.


Paul McCarthy's avatar
Paul McCarthy committed
450
451
452
453
454
455
456
457
458
459
460
0.10.4 (Friday 7th December 2018)
---------------------------------


Fixed
^^^^^


* Fixed an issue with the `--subject` command line option.


Paul McCarthy's avatar
Paul McCarthy committed
461
462
463
464
465
466
467
468
469
470
471
472
0.10.3 (Friday 7th December 2018)
---------------------------------


Fixed
^^^^^


* Made use of the standard library ``resource`` module conditional, as it is
  not present on Windows.


Paul McCarthy's avatar
Paul McCarthy committed
473
474
475
476
477
478
479
480
481
482
483
0.10.2 (Friday 7th December 2018)
---------------------------------


Fixed
^^^^^


* Removed relative imports from test modules.


Paul McCarthy's avatar
Paul McCarthy committed
484
485
486
487
488
489
490
491
492
493
494
495
0.10.1 (Friday 7th December 2018)
---------------------------------


Fixed
^^^^^


* The :mod:`ukbparse.plugins` package was missing an ``__init__.py``, and was
  not being included in PyPI packages.


Paul McCarthy's avatar
Paul McCarthy committed
496
497
498
499
500
501
502
503
504
505
506
0.10.0 (Thursday 6th December 2018)
-----------------------------------


Added
^^^^^


* New ``--na_values``, ``--recoding``, and ``--child_values`` command-line
  options for specifying/overriding NA insertion, categorical recodings,
  and child variable value replacement.
Paul McCarthy's avatar
Paul McCarthy committed
507
508
* ``--dry_run`` mode now prints information about columns that would not be
  loaded.
Paul McCarthy's avatar
Paul McCarthy committed
509
510


Paul McCarthy's avatar
Paul McCarthy committed
511
512
513
514
515
516
Fixed
^^^^^


* Fixed a bug in the :func:`.calculateExpressionEvaluationOrder` function.

Paul McCarthy's avatar
Paul McCarthy committed
517

Paul McCarthy's avatar
Paul McCarthy committed
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
0.9.0 (Thursday 6th December 2018)
----------------------------------


Added
^^^^^


* Infrastructure for automatic deployment to PyPI and Zenodo.


Changed
^^^^^^^


* Improved ``--dry_run`` output formatting.


Paul McCarthy's avatar
Paul McCarthy committed
536
537
538
539
540
541
542
543
544
545
546
547
0.8.0
-----


Added
^^^^^


* New ``--dry_run`` command-line option, which prints a summary of the cleaning
  and processing that would take place.


Paul McCarthy's avatar
Paul McCarthy committed
548
549
550
551
552
553
554
555
556
557
558
0.7.1
-----


Fixed
^^^^^


* Fixed a bug in the :func:`.icd10.saveCodes` function.


Paul McCarthy's avatar
Paul McCarthy committed
559
560
561
562
563
564
565
566
567
568
569
570
0.7.0
-----


Changed
^^^^^^^


* Small refactorings in :mod:`ukbparse.config` so that command line arguments
  can be logged easily.


Paul McCarthy's avatar
Paul McCarthy committed
571
572
573
574
575
576
577
578
579
580
581
0.6.3
-----


Changed
^^^^^^^


* Minor updates to avoid deprecation warnings.


Paul McCarthy's avatar
Paul McCarthy committed
582
583
584
585
586
587
588
589
590
591
592
593
0.6.2
-----


Fixed
^^^^^


* Fixed a bug with the ``--import_all`` option, where an error would be thrown
  if a specifically requested variable was removed during processing.


Paul McCarthy's avatar
Paul McCarthy committed
594
595
596
597
598
599
600
601
602
603
604
605
0.6.1
-----


Changed
^^^^^^^


* Changed default processing for variables 41202/41204 so they are binarised
  *within* visit.


Paul McCarthy's avatar
Paul McCarthy committed
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
0.6.0
-----


Added
^^^^^


* New ``--import_all`` and ``--unknown_vars_file`` options for outputting
  information about previously unknown variables/columns.


Changed
^^^^^^^


* Changed processing function return value interface - see the
  :mod:`.processing_functions` module for details.


Paul McCarthy's avatar
Paul McCarthy committed
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
0.5.0
-----


Added
^^^^^


* Ability to export a mapping file containing the numeric values that ICD10
  codes have been converted into - see the ``--icd10_map_file`` argument.


Changed
^^^^^^^


* Changes to default processing - all ICD10 variables are binarised by default.
  Sparsity/redundancy tests happen at the end, so that columns generated by
  previous steps are tested.


Fixed
^^^^^


* :meth:`.HDFStoreCollection.loc` method returns a ``pandas.DataFrame`` when
  a list of columns are indexed, and a ``pandas.Series`` when a single column
  is indexed.


Paul McCarthy's avatar
Paul McCarthy committed
656
657
658
659
660
661
662
663
664
665
666
0.4.1
-----


Changed
^^^^^^^


* Updates to variable table for UKBiobank spirometry variables.


Paul McCarthy's avatar
Paul McCarthy committed
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
0.4.0
-----


Added
^^^^^


* New :func:`.parseSpirometryData` function for parsing spirometry data
  (i.e. `UKBiobank variable 3066
  <https://biobank.ctsu.ox.ac.uk/crystal/field.cgi?id=3066>`_


Removed
^^^^^^^


* Removed the ``--disable_rename`` command line option, because having the
  columns renamed is really annoying.


Paul McCarthy's avatar
Paul McCarthy committed
688
689
690
691
692
693
694
695
696
697
698
0.3.3
-----


Changed
^^^^^^^


* Reverted the behaviour of :func:`.isSparse`.


Paul McCarthy's avatar
Paul McCarthy committed
699
700
701
702
703
704
705
706
707
708
709
710
711
0.3.2
-----


Changed
^^^^^^^


* Changed the behaviour of :func:`.isSparse` so that series which are *greater
  than* the ``minpres`` threshold pass, rather than *greater than or equal
  to*.


Paul McCarthy's avatar
Paul McCarthy committed
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
0.3.1
-----


Changed
^^^^^^^


* The :func:`.isSparse` function ignores the ``minpres`` argument if it
  is larger than the number of samples in the data set.


Fixed
^^^^^


* The :func:`.binariseCategorical` function now works on data with missing
  values.


Paul McCarthy's avatar
Paul McCarthy committed
732
733
734
735
736
737
738
739
740
741
742
743
744
0.3.0
-----


Added
^^^^^


* New :meth:`.DataTable.addColumns` method, so processing functions can
  now add new columns.
* New :func:`.binariseCategorical` processing function, which expands a
  categorical column into multiple binary columns, one for each unique
  value in the data.
Paul McCarthy's avatar
Paul McCarthy committed
745
746
* New :func:`.expandCompound` processing function, which expands a
  compound column into columns, one for each value in the compound data.
Paul McCarthy's avatar
Paul McCarthy committed
747
748
749
750
751
752
753
754
755
756
* Keyword arguments can now be used when specifying processing.


Fixed
^^^^^


* Fixed handling of non-numeric categorical variables


Paul McCarthy's avatar
Paul McCarthy committed
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
0.2.0
-----


Added
^^^^^

* Added a changelog file


Changed
^^^^^^^


* Updated variable/datacoding files to bring them in line with the latest
  Biobank data release.