CHANGELOG.rst 42.9 KB
Newer Older
Paul McCarthy's avatar
Paul McCarthy committed
1
2
FUNPACK release history
=======================
Paul McCarthy's avatar
Paul McCarthy committed
3

Paul McCarthy's avatar
Paul McCarthy committed
4

Paul McCarthy's avatar
Paul McCarthy committed
5
6
7
8
9
10
11
12
13
14
15
16

3.1.1 (Monday 9th May 2022)
---------------------------


Changed
^^^^^^^


* Updated categorisations in the ``fmrib`` configuration profile.


Paul McCarthy's avatar
Paul McCarthy committed
17
3.1.0 (Thursday 5th May 2022)
Paul McCarthy's avatar
Paul McCarthy committed
18
19
20
21
22
23
-----------------------------


Added
^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
24

Paul McCarthy's avatar
Paul McCarthy committed
25
26
27
28
29
* New ``numeric`` and ``convertNumeric`` options to the
  :func:`.flattenHierarchical` cleaning function, which allow it to be used
  with unique numeric labels (node IDs) for hierarchical data encodings,
  rather than coding labels (which are not necessarily numeric, or unique)
  (!88).
Paul McCarthy's avatar
Paul McCarthy committed
30
31


Paul McCarthy's avatar
Paul McCarthy committed
32
33
34
35
36
37
38
39
Changed
^^^^^^^


* Updated internal data field and data coding to the latest from the UK
  BioBank showcase.


Paul McCarthy's avatar
Paul McCarthy committed
40
41
42
43
44
Fixed
^^^^^


* Fixed an issue with the interpretation of hierarchical data codings, which
Paul McCarthy's avatar
Paul McCarthy committed
45
  was causing the ``flattenHierarchical`` cleaning function to crash (!88).
Paul McCarthy's avatar
Paul McCarthy committed
46
47


Paul McCarthy's avatar
Paul McCarthy committed
48
49
50
51
52
53
54
55
56
57
58
59
3.0.0 (Wednesday 5th January 2022)
----------------------------------


Changed
^^^^^^^


* The ``funpack`` command has been renamed to ``fmrib_unpack``, to avoid
  naming conflicts with other packages.


Paul McCarthy's avatar
Paul McCarthy committed
60
61
62
63
64
65
66
67
68
69
70
71
2.9.1 (Wednesday 29th December 2021)
------------------------------------


Fixed
^^^^^


* Fixed some compatibility issues with Python 3.10.



Paul McCarthy's avatar
Paul McCarthy committed
72
73
74
75
76
77
78
79
80
81
2.9.0 (Tuesady 28th December 2021)
----------------------------------


Added
^^^^^


* New ``--remove_duplicates`` option, which causes columns with duplicate
  names to be removed, with only the first retained.
Paul McCarthy's avatar
Paul McCarthy committed
82
83
84
85
86
87
88
89
90


Changed
^^^^^^^


* Explicitly use the ``fork`` method for the ``multiprocessing`` module.


Paul McCarthy's avatar
Paul McCarthy committed
91
92
2.8.0 (Thursday 19th August 2021)
---------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109


Added
^^^^^


* New ``skipUnknowns`` option to the ``removeIfRedundant`` processing function,
  whereby if a column is found to be redundant with respect to a column of an
  unkknown or uncategorised data field, it is *not* dropped. This option is
  used in the ``fmrib`` configuration.


Changed
^^^^^^^


* Added a recoding rule for data coding `100348
Paul McCarthy's avatar
Paul McCarthy committed
110
  <https://biobank.ctsu.ox.ac.uk/crystal/coding.cgi?id=100348>`_ to the
Paul McCarthy's avatar
Paul McCarthy committed
111
  ``fmrib`` configuration.
Paul McCarthy's avatar
Paul McCarthy committed
112

Paul McCarthy's avatar
Paul McCarthy committed
113
114
115
116
117
118
119
120
121
122
123
124
125
126

2.7.1 (Tuesday 22nd June 2021)
------------------------------


Fixed
^^^^^


* Fixed some issues with the ``binariseCategorical`` and ``removeIfSparse``
  processing functions, which could cause them to cause a crash when
  processing empty columns.


Paul McCarthy's avatar
Paul McCarthy committed
127
128
2.7.0 (Friday 14th May 2021)
----------------------------
Paul McCarthy's avatar
Paul McCarthy committed
129
130
131
132
133
134
135
136
137
138


Changed
^^^^^^^


* The ``--na_values``, ``--child_values`` and ``--recoding`` options can now
  be applied to non-numeric data fields.
* Updated internal data field and data coding to the latest from the UK
  BioBank showcase.
Paul McCarthy's avatar
Paul McCarthy committed
139
* Updates to FMRIB categories and processing rules.
Paul McCarthy's avatar
Paul McCarthy committed
140
141


Paul McCarthy's avatar
Paul McCarthy committed
142
143
144
145
146
147
148
149
2.6.0 (Monday 29th March 2021)
------------------------------


Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
150
151
* Documentation for FUNPACK can now be found online at
  https://open.win.ox.ac.uk/pages/fsl/funpack/.
Paul McCarthy's avatar
Paul McCarthy committed
152
153
154
155
156
157
158
159
160
* The way that "uncategorised" variables are identified has been changed.
  Previously, a variable which was not in a category *and* which had no
  cleaning/processing rules specified was classified as uncategorised. This
  has been simplified so that a variable which not in a category is classified
  as uncategorised. This has been done to avoid the possibility of missing
  newly added variables which use an existing data coding, and therefore may
  implicitly have cleaning rules specified for them.


Paul McCarthy's avatar
Paul McCarthy committed
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
2.5.2 (Monday 15th March 2021)
------------------------------


Changed
^^^^^^^


* A warning message is now emitted if a processing step is requested for a
  variable that is not present in the input data.


Fixed
^^^^^


* Fixed an issue with the ``binariseCatgegorical`` processing function where,
  when it was applied to multiple variables, each with a separate ``take``
  variable (as is the case in the ``fmrib`` configuration), would cause an
  error if any of the ``take`` variables were not present.


183
184
2.5.1 (Wednesday 3rd March 2021)
--------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
185
186


Paul McCarthy's avatar
Paul McCarthy committed
187
188
189
190
191
192
193
194
Added
^^^^^


* New ``--escape_newlines`` option, which causes non-numeric values containing
  escape characters (e.g. ``\n``, ``\t``, etc) to be output literally.


Paul McCarthy's avatar
Paul McCarthy committed
195
196
197
198
199
200
Fixed
^^^^^


* Fixed a bug where subject inclusion expressions were causing zero rows to be
  imported if the variable was not present in the input file.
Paul McCarthy's avatar
Paul McCarthy committed
201
* Fixed some compatibility issues with Pandas 1.2.
Paul McCarthy's avatar
Paul McCarthy committed
202
203


Paul McCarthy's avatar
Paul McCarthy committed
204
205
206
207
208
209
210
211
212
213
2.5.0 (Wednesday 9th December 2020)
-----------------------------------


Added
^^^^^


* New ``--rename_duplicates`` option, which can be used to give duplicate
  columns unique names.
Paul McCarthy's avatar
Paul McCarthy committed
214
215
216
217
218
219


Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
220
221
* Conditional expressions used with the ``--subject`` option can now be used
  on date/time variables.
Paul McCarthy's avatar
Paul McCarthy committed
222
223
224
* Internal re-organisation of the ``funpack.fileinfo`` module, and minor
  changes to function interfaces in the ``funpack.importing`` and
  ``funpack.loadtables`` modules.
Paul McCarthy's avatar
Paul McCarthy committed
225
226


Paul McCarthy's avatar
Paul McCarthy committed
227
228
229
230
231
232
233
234
235
236
237
2.4.0 (Thursday 26th November 2020)
___________________________________


Added
^^^^^


* New ``--ids_only`` option which causes only the subject IDs to be saved,
  suitable for use with the ``--subject`` option in subsequent calls to
  ``funpack``.
Paul McCarthy's avatar
Paul McCarthy committed
238
239
240
241
242
243
244


Changed
^^^^^^^

* Changed how binary subject selection expressions are evaluated when the
  different variables have different numbers of columns.
Paul McCarthy's avatar
Paul McCarthy committed
245
246
247
248
249
* All internal UKB showcase data tables have been updated to their
  latest versions.
* The node name for `Chapter V - Supplementary classification ...` in the ICD9
  data table has been changed from `Chapter V` to `Chapter V sup` to avoid
  collisions with the `Chapter V` node.
Paul McCarthy's avatar
Paul McCarthy committed
250
251


Paul McCarthy's avatar
Paul McCarthy committed
252
253
254
255
256
257
258
259
260
261
262
2.3.3 (Wednesday 5th October 2020)
----------------------------------


Changed
^^^^^^^


* Improved performance when appying the ``--column`` command-line argument.


Paul McCarthy's avatar
Paul McCarthy committed
263
264
265
266
267
268
269
270
271
272
273
274
2.3.2 (Wednesday 10th June 2020)
--------------------------------


Fixed
^^^^^


* Fixed an issue which was preventing FUNPACK from being used on Windows
  platforms (!65).


Paul McCarthy's avatar
Paul McCarthy committed
275
276
2.3.1 (Sunday 17th May 2020)
----------------------------
Paul McCarthy's avatar
Paul McCarthy committed
277
278


Paul McCarthy's avatar
Paul McCarthy committed
279
280
281
282
283
284
Changed
^^^^^^^


* The :func:`.removeIfSparse` processing function can now parallelise the
  check across columns, rather than relying on the :mod:`.processing` module
Paul McCarthy's avatar
Paul McCarthy committed
285
  to parallelise calls across variables (!64).
Paul McCarthy's avatar
Paul McCarthy committed
286
287


Paul McCarthy's avatar
Paul McCarthy committed
288
289
290
291
292
Fixed
^^^^^


* The improved :mod:`.fmrib` date/time normalisation routines were not
Paul McCarthy's avatar
Paul McCarthy committed
293
294
295
  converting ``NaTs`` (Not-a-Time) correctly (!62).
* Fixed a problem in the FMRIB configuration - diagnosis timestamps were not
  being injected into binarised ICD variables (!63).
Paul McCarthy's avatar
Paul McCarthy committed
296
297


Paul McCarthy's avatar
Paul McCarthy committed
298
299
2.3.0 (Tuesday 12th May 2020)
-----------------------------
Paul McCarthy's avatar
Paul McCarthy committed
300
301
302
303
304
305


Changed
^^^^^^^


306
307
308
* Modified the :func:`.processing_functions.binariseCategorical` function so
  that it parallelises tasks internally, instead of being called in parallel
  for different variables. This should give superior performance (!60).
Paul McCarthy's avatar
Paul McCarthy committed
309
* Revisited the :meth:`.DataTable.merge` to optimise performance in all
Paul McCarthy's avatar
Paul McCarthy committed
310
  scenarios (!60).
Paul McCarthy's avatar
Paul McCarthy committed
311
312
313
314
* Improved performance of the :mod:`.fmrib` date/time normalisation routines,
  and changed their usage so they are now applied as "cleaning" functions
  after data import, rather than just before export. This means that date/
  time columns can be subjected to the redundancy check (as they will have
Paul McCarthy's avatar
Paul McCarthy committed
315
  a numeric type), and will improve data export performance (!60, !61).
Paul McCarthy's avatar
Paul McCarthy committed
316
317


Paul McCarthy's avatar
Paul McCarthy committed
318
319
320
321
322
323
324
325
326
327
328
329
2.2.1 (Monday 4th May 2020)
---------------------------


Fixed
^^^^^


* Reverted some changes to :meth:`.DataTable.merge` which caused performance
  degradations.


Paul McCarthy's avatar
Paul McCarthy committed
330
331
2.2.0 (Friday 1st May 2020)
---------------------------
Paul McCarthy's avatar
Paul McCarthy committed
332
333
334
335
336
337


Changed
^^^^^^^


338
339
340
341
342
343
344
345
346
347
* Substantial performance improvements to the
  :func:`.cleaning_functions.codeToNumeric` cleaning function, and to
  :func:`.processing_functions.removeIfRedundant`,
  :func:`.processing_functions.binariseCategorical`, and other processing
  functions.
* The default implementation of
  :func:`.processing_functions.removeIfRedundant` now uses matrix algebra
  rather thsn pairwise comparisons. This requires more memory, but is much
  faster.
* Added `threadpoolctl <https://github.com/joblib/threadpoolctl/>`_ as a
Paul McCarthy's avatar
Paul McCarthy committed
348
349
  dependency, for setting the number of threads to use when parallelising
  ``numpy`` operations.
Paul McCarthy's avatar
Paul McCarthy committed
350
351
352
353
354
355
356
357


Fixed
^^^^^


* The :func:`.removeIfRedundant` processing function was not testing columns
  with no missing values when a NA correlation threshold was being used.
Paul McCarthy's avatar
Paul McCarthy committed
358
359
* :func:`.removeIfRedundant` was also potentially producing inconsistent
  results for columns with no present values, or with a constant value.
Paul McCarthy's avatar
Paul McCarthy committed
360
361


Paul McCarthy's avatar
Paul McCarthy committed
362
363
364
365
366
367
368
369
370
371
2.1.0 (Tuesday 21st April 2020)
-------------------------------


Added
^^^^^


* New ``--drop_na_rows`` option, which tells ``funpack`` to drop rows which do
  not contain a value for any column.
Paul McCarthy's avatar
Paul McCarthy committed
372
373
374
375
376
377
378
379
380


Changed
^^^^^^^


* Internal changes to improve performance.


Paul McCarthy's avatar
Paul McCarthy committed
381
2.0.0 (Tuesday 7th April 2020)
Paul McCarthy's avatar
Paul McCarthy committed
382
------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
383
384


Paul McCarthy's avatar
Paul McCarthy committed
385
386
387
388
Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
389
390
391
* The ``fmrib`` and ``fmrib_logs`` configuration profiles no longer define the
  variables/categories to be loaded - by default all variables in the input file
  will be loaded and processed.
Paul McCarthy's avatar
Paul McCarthy committed
392
393
394
395
* The ``--non_numeric_file`` option has been replaced with ``--suppress_non_numerics``
  (which tells FUNPACK to only save numeric columns to the main output file),
  and the ``--write_non_numerics`` and ``--non_numerics_file`` options, which
  tell FUNPACK to save non-numeric columns to an auxillary output file.
Paul McCarthy's avatar
Paul McCarthy committed
396
397
* The ``--tsv_var_format`` option has been renamed to ``--var_format``, and is
  applied to all export formats.
Paul McCarthy's avatar
Paul McCarthy committed
398
399
400
401
402
403
404
405
* The default output file format is now inferred from the output file suffix -
  one of ``tsv``, ``csv``, or ``h5``.
* The format of the ``--unknown_vars_file`` has changed - the ``processed``
  column has been removed (as with the removal of the ``--import_all`` option,
  it is now equivalent to the ``exported`` column), and uncategorised columns
  now have a ``class`` of ``uncategorised`` instead of ``unprocessed``.


Paul McCarthy's avatar
Paul McCarthy committed
406
407
408
409
410
411
412
413
Removed
^^^^^^^


* Removed several obscure, redundant, or deprecated options, including
  ``--import_all``, ``--remove_unknown``, ``--pass_through``,
  ``--output_id_column``, ``--column_pattern``, ``--column_name``,
  ``--low_memory``, and ``--work_dir``.
Paul McCarthy's avatar
Paul McCarthy committed
414
415
* Removed the unused :mod:`funpack.storage` module.
* Removed the unused :meth:`.DataTable.order` method.
Paul McCarthy's avatar
Paul McCarthy committed
416
417


Paul McCarthy's avatar
Paul McCarthy committed
418
419
420
421
422
423
424
425
426
427
428
1.9.1 (Sunday 29th March 2020)
------------------------------


Changed
^^^^^^^


* Updates to FMRIB categories.


Paul McCarthy's avatar
Paul McCarthy committed
429
430
1.9.0 (Friday 28th February 2020)
---------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445


Added
^^^^^


* New ``--write_log``, ``--write_unknown_vars``, ``--write_icd10_map``,
  ``--write_description``, and ``--write_summary`` options, which will save
  the respective auxillary output file using a default naming convention which
  is based on the name of the main output file. Exact names can still be
  specified via the ``--log_file``, ``--unknown_vars_file``,
  ``--icd10_map_file``, ``--description_file``, and ``--summary_file``
  options.


Paul McCarthy's avatar
Paul McCarthy committed
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
Changed
^^^^^^^


* Refactored the ``fmrib`` configuration profile. ``fmrib`` now just applies
  cleaning/processing rules. ``fmrib_logs`` applies ``fmrib``, and also
  specifies logging/auxillary output files.


Removed
^^^^^^^


* Removed the built-in ``ukb`` configuration.


Paul McCarthy's avatar
Paul McCarthy committed
462
463
464
Deprecated
^^^^^^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
465

Paul McCarthy's avatar
Paul McCarthy committed
466
467
468
469
470
* The ``--pass_through`` option is deprecated - the same behaviour can be
  achieved by running FUNPACK without specifying any cleaning or processing
  steps.


Paul McCarthy's avatar
Paul McCarthy committed
471
472
473
474
475
476
477
478
1.8.2 (Monday 24th February 2020)
---------------------------------


Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
479
480
481
* The ``--config_file`` option can be used more than once, and can also be
  used from within a configuration file (i.e. one configuration file may
  "include" another).
482
483
* Changed the way that the :func:`.processing_functions.removeIfRedundant`
  process splits up the data set for parallel processing.
Paul McCarthy's avatar
Paul McCarthy committed
484
485


Paul McCarthy's avatar
Paul McCarthy committed
486
487
488
489
490
491
492
493
1.8.1 (Wednesday 19th February 2020)
------------------------------------


Added
^^^^^


494
495
* New ``naval`` option to the :func:`.processing_functions.removeIfSparse`
  processing function.
Paul McCarthy's avatar
Paul McCarthy committed
496
497
498
499
500
501
502
503
504
505


Changed
^^^^^^^


* Changes to the ``fmrib`` configuration, to correctly apply sparsity check
  to variables 41202, 41203, 41270 and 41271.


Paul McCarthy's avatar
Paul McCarthy committed
506
507
1.8.0 (Tuesday 18th February 2020)
----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
508
509
510
511
512
513


Added
^^^^^


514
515
516
517
518
519
520
* New ``take`` option to the :func:`.processing_functions.binariseCategorical`
  processing function, which allows the generated columns to contain values
  from another column, instead of containing binary labels.
* New ``fillval`` option to the
  :func:`.processing_functions.binariseCategorical` processing function, which
  can be used in conjunction with ``take``, to specify the fill value for
  missing rows.
Paul McCarthy's avatar
Paul McCarthy committed
521
522
523
524
525
526
* Argument **broadcasting** for processing functions - when a process is
  applied independently to more than one variable, the input arguments to the
  process may need to be different for each variable. This can be accomplished
  by using a _broadcast_ argument - simply prefix the argument name with
  ``'broadcast_'``, and then specify a list containing the argument.
* Processing functions can now be passed lists of values.
Paul McCarthy's avatar
Paul McCarthy committed
527
528


Paul McCarthy's avatar
Paul McCarthy committed
529
530
531
532
Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
533
534
535
536
537
538
539
* Changes to the ``fmrib`` configuration - variables
  `41202 <http://biobank.ctsu.ox.ac.uk/crystal/field.cgi?id=41202>`_,
  `41203 <http://biobank.ctsu.ox.ac.uk/crystal/field.cgi?id=41203>`_,
  `41270 <http://biobank.ctsu.ox.ac.uk/crystal/field.cgi?id=41270>`_, and
  `41271 <http://biobank.ctsu.ox.ac.uk/crystal/field.cgi?id=41271>`_ are
  binarised, and the binarised values replaced with diagnosis dates from
  the corresponding date variables.
Paul McCarthy's avatar
Paul McCarthy committed
540
541
542
543
544
545
* The processing function interface has been changed - processing functions
  which return metadata for newly added columns must now return a sequence of
  dicts containing arguments to the :class:`.Column` constructor, which can
  include metadata.


Paul McCarthy's avatar
Paul McCarthy committed
546
547
548
549
550
551
552
553
554
Fixed
^^^^^


* Fixed a bug whereby only the first two conditions were being parsed in
  an expression comprising multiple identical chained boolean operations
  (e.g. `v10 == 1 || v20 == 2 || v30 == 3`).


Paul McCarthy's avatar
Paul McCarthy committed
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
1.7.1 (Thursday 30th January 2020)
----------------------------------


Added
^^^^^


* New built-in ``ukb`` configuration, which applies NA insertion, categorical
  recoding, and child value replacement rules from the ``fmrib`` configuration.


Fixed
^^^^^

* Fixed a bug which arose from combining the ``--import_all`` and ``--column``
  options.


Paul McCarthy's avatar
Paul McCarthy committed
574
575
1.7.0 (Friday 24th January 2020)
--------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
576
577
578
579
580
581
582
583
584
585


Added
^^^^^


* New ``--index_visits`` option, which re-arranges variables with separate
  columns per visit into single columns indexed by both subject ID and visit.


Paul McCarthy's avatar
Paul McCarthy committed
586
587
588
589
590
591
592
593
594
595
596
Changed
^^^^^^^


* The ``--index`` option now supports specification of multiple index columns
  for each input file.
* The :func:`.fileinfo.has_header` function has been modified to be more
  lenient.
* The :mod:`.importing` module has been internally refactored to improve
  code cleanliness.
* Various minor internal API changes.
Paul McCarthy's avatar
Paul McCarthy committed
597
* The :func:`.removeIfRedundant` processsing function will now drop columns
Paul McCarthy's avatar
Paul McCarthy committed
598
599
600
601
602
603
604
  which are redundant with respect to other columns which have already been
  dropped.
* Update to the FMRIB configuration (handling variable `6150
  <https://biobank.ctsu.ox.ac.uk/crystal/field.cgi?id=6150>`_).
* The ``'codingdesc'`` metaproc function takes into account possible
  categorical recodings when retrieving the description for a particular
  value.
Paul McCarthy's avatar
Paul McCarthy committed
605
606
607
608
609
610
611
612


Fixed
^^^^^


* The :func:`.removeIfRedundant` processsing function was unnecessarily
  evaluating column pairs more than once, when run in parallel.
Paul McCarthy's avatar
Paul McCarthy committed
613
614


Paul McCarthy's avatar
Paul McCarthy committed
615
616
1.6.0 (Wednesday 11th December 2019)
------------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
617
618
619
620
621
622
623


Added
^^^^^


* Non-numeric variables can now be used in conditional expressions, e.g.
624
  ``'v41202 == "A009"'``. Within such expressions, the value must be contained
Paul McCarthy's avatar
Paul McCarthy committed
625
626
627
628
629
  within single or double quotes.
* New ``contains`` operator, for use within conditional expressions to test
  presence of sub-strings.


Paul McCarthy's avatar
Paul McCarthy committed
630
631
632
633
634
635
Changed
^^^^^^^


* Parallelisation is now disabled by default, and must be explicitly enabled
  via the ``--num_jobs`` option. This is done in the ``fmrib`` configuration.
Paul McCarthy's avatar
Paul McCarthy committed
636
637
638
* Subject inclusion expressions are now evaluated during, rather than after,
  data import. They are now therefore performed in parallel on different
  chunks of the input file(s) (when parallelisaton is enabled).
Paul McCarthy's avatar
Paul McCarthy committed
639
640


Paul McCarthy's avatar
Paul McCarthy committed
641
642
1.5.0 (Monday 9th December 2019)
--------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
643
644
645
646
647
648


Added
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
649
* New :func:`.util.wc` function to count the rows (lines) of a file;
Paul McCarthy's avatar
Paul McCarthy committed
650
  this is simply a wrapper around the UNIX ``wc`` tool.
Paul McCarthy's avatar
Paul McCarthy committed
651
652
* New :func:`.util.cat` function to concatenate multiple files together;
  this is simply a wrapper around the UNIX ``cat`` tool.
Paul McCarthy's avatar
Paul McCarthy committed
653
654
* New :func:`.util.inMainProcess` function so a process can determine whether
  it is the main process or a worker process.
Paul McCarthy's avatar
Paul McCarthy committed
655
656
657
658
* New :meth:`.DataTable.subtable` and :meth:`.DataTable.merge` methods, to aid
  in passing data to/from worker processes.
* Processing functions can now be specified to run independently on a subset
  of variables by using ``'independent'`` in the variable list.
Paul McCarthy's avatar
Paul McCarthy committed
659
660
* New ``any`` and ``all`` operations which can be used in conditional
  statements to control how the conditional results are combined across
Paul McCarthy's avatar
Paul McCarthy committed
661
662
  multiple columns for one variable. These can be used with the ``--subject``
  option.
Paul McCarthy's avatar
Paul McCarthy committed
663
664
665
666
667
668
669


Changed
^^^^^^^


* FUNPACK will now parallelise tasks by default; previously it would only
Paul McCarthy's avatar
Paul McCarthy committed
670
671
672
673
674
675
676
677
678
679
680
681
682
  parallelise tasks if ``--low_memory`` mode were selected.
* The data import stage is parallelised by using multiple processes to read
  different chunks of the input file(s), and then concatenating the resulting
  ``pandas.DataFrame`` objects afterwards.
* Cleaning functions are executed on each variable in parallel.
* Each processing step is executed in parallel where possible
  (e.g. ``independent`` processes), but processing steps are still executed
  sequentially.  New columns created by processing functions are saved to
  disk, and re-loaded by the main process, rather than being passed back to
  the main process via inter-process communication.
* The ``removeIfRedundant`` process now compares pairs of columns in parallel.
* The data export stage is parallelised by writing chunks of rows to different
  files, and then concatenating them into a single output file afterwards.
Paul McCarthy's avatar
Paul McCarthy committed
683
684
* The ``--variable``, ``--subject`` and ``--exclude`` options now accept
  comma-separated mixtures of IDs and MATLAB-style ranges.
Paul McCarthy's avatar
Paul McCarthy committed
685
686
687
688
* Updates to FMRIB categories.
* Updates to FMRIB processing rules, to take advantage of parallelism.
* The ,:mod:`icd10` module must now be initialised via the
  :func:`.icd10.initialise` function, when it is to be used in a multiprocessing
Paul McCarthy's avatar
Paul McCarthy committed
689
  context. This is not necessary when ``funpack`` is configured to not
Paul McCarthy's avatar
Paul McCarthy committed
690
  parallelise tasks (e.g. with ``--num_jobs 1``).
Paul McCarthy's avatar
Paul McCarthy committed
691
692
693
694
695
696
697


Deprecated
^^^^^^^^^^


* The ``--low_memory`` and ``--work_dir`` options have been deprecated, and no
Paul McCarthy's avatar
Paul McCarthy committed
698
699
  longer have any effect. The :mod:`.storage` module is no longer used, but is
  still present for possible future usage.
Paul McCarthy's avatar
Paul McCarthy committed
700
701
702
703


1.4.5 (Thursday 5th December 2019)
----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
704
705


Paul McCarthy's avatar
Paul McCarthy committed
706
707
708
709
710
711
712
713
Changed
^^^^^^^


* The ``funpack_demo`` notebook is now executed from a temporary directory, so
  it does not require write-permissions to the FUNPACK installation directory.


Paul McCarthy's avatar
Paul McCarthy committed
714
715
716
717
Fixed
^^^^^


718
719
720
* Fixed a bug where non-numeric variables (e.g.
  `41271 <https://biobank.ctsu.ox.ac.uk/crystal/field.cgi?id=41271>`_ ) were
  being interpreted by ``pandas`` as being numeric.
Paul McCarthy's avatar
Paul McCarthy committed
721
722


Paul McCarthy's avatar
Paul McCarthy committed
723
724
725
726
727
728
729
730
731
732
733
1.4.4 (Friday 15th November 2019)
---------------------------------


Changed
^^^^^^^


* Updates to the FMRIB categories and configuration.


Paul McCarthy's avatar
Paul McCarthy committed
734
735
736
737
738
739
740
741
742
743
1.4.3 (Monday 11th November 2019)
---------------------------------


Changed
^^^^^^^


* Updated internal variable and data coding tables to the latest available from
  the UK Biobank showcase.
Paul McCarthy's avatar
Paul McCarthy committed
744
* Increased the file sample size used by :func:`.fileinfo.sniff`.
Paul McCarthy's avatar
Paul McCarthy committed
745

Paul McCarthy's avatar
Paul McCarthy committed
746
747
748
749
750
751
752
753
754
755
756
757

1.4.2 (Tuesday 6th August 2019)
-------------------------------


Changed
^^^^^^^


* Minor changes to the FMRIB configuration.


Paul McCarthy's avatar
Paul McCarthy committed
758
1.4.1 (Monday 8th July 2019)
Paul McCarthy's avatar
Paul McCarthy committed
759
----------------------------
Paul McCarthy's avatar
Paul McCarthy committed
760
761
762
763
764
765
766
767
768
769
770
771


Added
^^^^^


* New ``--trust_types`` command-line flag which tells FUNPACK to assume that
  the data in known-to-be-numeric columns is parseable (i.e. that there are no
  bad/unparseable values). This option improves import performance, but at the
  cost of causing FUNPACK to crash if the assumption is not true.


Paul McCarthy's avatar
Paul McCarthy committed
772
773
774
775
776
777
778
779
780
781
782
783
1.4.0 (Sunday 7th July 2019
---------------------------


Added
^^^^^


* Added a new ``InternalType`` column to the variable table, which can be used
  to specify the type to use internally for a given variable
  (e.g. ``float64``).  This is so that the default type of ``float32`` can be
  overridden for specific variables for which this is problematic, such as
784
785
786
  variable
  `20003 <https://biobank.ctsu.ox.ac.uk/crystal/field.cgi?id=20003>`_.
  This column is initially populated from ``funpack/data/type.txt``.
Paul McCarthy's avatar
Paul McCarthy committed
787
788
* New :mod:`funpack.coding` module, for retrieving descriptive information
  about data codings. The information is stored in the
789
  ``funpack/data/coding/`` directory.  Hierarchical data codings are still
Paul McCarthy's avatar
Paul McCarthy committed
790
791
792
793
794
795
796
797
798
799
800
  accessed via the :mod:`.hierarchy` module.
* New :func:`hierarchicalDescriptionFromCode`,
  :func:`hierarchicalDescriptionFromNumeric`, and
  :func:`codingDescriptionFromValue` metaprocessing functions.



Changed
^^^^^^^

* The hierarchical coding name no longer needs to be specified when using the
801
802
  :func:`.cleaning_functions.codeToNumeric` cleaning function - the coding is
  automatically looked up.
Paul McCarthy's avatar
Paul McCarthy committed
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
* Variable 4288 has been moved from ``cognitive phenotypes`` to
  ``miscellaneous`` in the FMRIB categories.
* Variable 20003 is now binarised in the FMRIB categories.
* Changed the meta-processing function signature - these functions are now
  passed the :class:`.DataTable` and variable ID, in addition the value.


Fixed
^^^^^


* Now using an internal type of ``float64`` for variable 20003, as it
  potentially has values which cannot be represented in ``float32``.


Deprecated
^^^^^^^^^^


* Deprecated the `xDescriptionFromCode` and `xDescriptionFromNumeric`
  metaprocessing functions.


Paul McCarthy's avatar
Paul McCarthy committed
826
827
828
829
830
831
832
833
834
835
836
1.3.2 (Tuesday 4th June 2019)
-----------------------------


Changed
^^^^^^^


* Minor adjustments to the FMRIB categories.


Paul McCarthy's avatar
Paul McCarthy committed
837
838
839
840
841
842
843
844
845
846
847
1.3.1 (Thursday 30th May 2019)
------------------------------


Changed
^^^^^^^


* Updates to documentation.


Paul McCarthy's avatar
Paul McCarthy committed
848
849
850
851
852
853
854
855
1.3.0 (Wednesday 29th May 2019)
-------------------------------


Added
^^^^^


856
857
* New :func:`.cleaning_functions.codeToNumeric` cleaning function, for
  transforming hierarhical variable codes.
Paul McCarthy's avatar
Paul McCarthy committed
858
859
* New :func:`.hierarchy.codeToNumeric` and
  :func:`.hierarchy.numericToCode` functions.
Paul McCarthy's avatar
Paul McCarthy committed
860
861
* New meta-process functions for generating descriptions for ICD9, OPCS3 and
  OPCS4 hierarchical variables.
Paul McCarthy's avatar
Paul McCarthy committed
862
863
864
865
* Variable, data coding, processing, category and type files in the
  ``funpack/config`` directory can be specified on the command line and in
  configuration files as relative paths, and using a "dot" syntax, e.g.
  ``fmrib/categories.tsv``, or ``fmrib.categories``.
Paul McCarthy's avatar
Paul McCarthy committed
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880


Changed
^^^^^^^


* Built-in cleaning and processing rules are no longer applied by default -
  they are now a part of the built-in ``fmrib`` configuration, and can be
  applied via ``-cfg fmrib``.
* Updates to built-in ``fmrib`` processing.
* The ``flattenHierarchical`` processing function accepts a ``name`` argument,
  allowing the hierarchical data type name to be specified.  If not provided,
  the type is inferred from the variable ID if possible.


Paul McCarthy's avatar
Paul McCarthy committed
881
882
883
884
885
886
887
888
Fixed
^^^^^


* Fixed a bug where a processing step attempted to add a new column with
  the same name as an existing one.


Paul McCarthy's avatar
Paul McCarthy committed
889
890
891
892
Deprecated
^^^^^^^^^^


893
894
895
* The :func:`.convertICD10Codes` cleaning function has been replaced by the
  new :func:`.cleaning_functions.codeToNumeric` function, which can be used
  with any hierarchical variable.
Paul McCarthy's avatar
Paul McCarthy committed
896
897
898
899
900
901
902
* The :func:`.icd10.codeToNumeric` and :func:`.icd10.numericToCode` functions
  have been replaced by the :func:`.hierarchy.codeToNumeric` and
  :func:`.hierarchy.numericToCode` functions.
* The :func:`.loadDefaultTables` function is obsolete and has been deprecated.



Paul McCarthy's avatar
Paul McCarthy committed
903
904
905
906
907
908
909
910
911
912
913
1.2.1 (Tuesday 28th May 2019)
-----------------------------


Changed
^^^^^^^


* Minor changes to built-in variable categories.


Paul McCarthy's avatar
Paul McCarthy committed
914
1.2.0 (Saturday 25th May 2019)
Paul McCarthy's avatar
Paul McCarthy committed
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
------------------------------


Added
^^^^^


* New ``--summary_file`` option, which exports a summary of the
  cleaning/processing steps that have been applied to each variable.


Changed
^^^^^^^


* Built-in recoding, NA insertion, and child value replacement rules have
Paul McCarthy's avatar
Paul McCarthy committed
931
  been revised and updated.
Paul McCarthy's avatar
Paul McCarthy committed
932
933


Paul McCarthy's avatar
Paul McCarthy committed
934
935
936
937
938
939
940
941
942
943
944
945
1.1.4 (Friday 17th May 2019)
----------------------------


Changed
^^^^^^^


* Changed default processing rules so a column with standard deviation less
  than ``1e-6`` is deemed sparse, and dropped.


Paul McCarthy's avatar
Paul McCarthy committed
946
947
948
949
950
951
952
953

1.1.3 (Thursday 16th May 2019)
------------------------------


Changed
^^^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
954

Paul McCarthy's avatar
Paul McCarthy committed
955
956
* The :func:`.isSparse` function has been changed so that, when the ``mincat``
  or ``maxcat`` tests are specified as proportions, they are applied relative
Paul McCarthy's avatar
Paul McCarthy committed
957
  to the number of *non-missing* data points, rather than the total number of
Paul McCarthy's avatar
Paul McCarthy committed
958
959
960
  data points.


Paul McCarthy's avatar
Paul McCarthy committed
961
962
963
964
965
966
967
968
969
970
971
972
973
1.1.2 (Thursday 16th May 2019)
------------------------------


Fixed
^^^^^


* Fixed a bug in :func:`.flattenHierarchical` with respect to handling missing
  values.


1.1.1 (Wednesday 15th May 2019)
Paul McCarthy's avatar
Paul McCarthy committed
974
975
976
977
978
979
980
981
982
983
984
-------------------------------


Fixed
^^^^^


* Changed the :func:`.isSparse` function to avoid issues with non-numaric
  data.


Paul McCarthy's avatar
Paul McCarthy committed
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1.1.0 (Tuesday 14th May 2019)
-----------------------------


Changed
^^^^^^^


* The ``--visit``/``-vi`` command line option will no longer be applied to
  variables which do not have an `instancing
  <https://biobank.ctsu.ox.ac.uk/crystal/schema.cgi?id=9>`_ code 2.
  This is implemented in the :func:`.keepVisits` function.
* The :func:`.remove` and :func:`.keepVisits` function signatures have changed
  - they now require the variable table to be passed in as the first argument.


Paul McCarthy's avatar
Paul McCarthy committed
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1.0.2 (Tuesday 14th May 2019)
-----------------------------


Changed
^^^^^^^


* The :func:`.removeIfSparse` processing function accepts an ``ignoreType``
  parameter which forces all tests to be run, regardless of the variable type.


Fixed
^^^^^


* The :func:`.isSparse` function was skipping the ``mincat``/``maxcat`` tests
  for non-numeric categorical variables.

Paul McCarthy's avatar
Paul McCarthy committed
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031

1.0.1 (Friday 9th May 2019)
---------------------------


Changed
^^^^^^^


* Python package name changed from ``fmrib_unpack`` to ``fmrib-unpack``.


Paul McCarthy's avatar
Paul McCarthy committed
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1.0.0 (Friday 9th May 2019)
---------------------------


Changed
^^^^^^^


* ``ukbparse`` is now called ``FUNPACK`` - the *FMRIB UKBiobank Normalisation,
  Processing And Cleaning Kit*.
Paul McCarthy's avatar
Paul McCarthy committed
1042

Paul McCarthy's avatar
Paul McCarthy committed
1043

Paul McCarthy's avatar
Paul McCarthy committed
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
Removed
^^^^^^^


* The ``ukbparse_htmlparse``, ``ukbparse_join``, and
  ``ukbparse_compare_tables`` scripts have been removed.
* The ``ukbparse.icd10.readICD10CodingFile`` function and
  ``ukbparse.icd10.ICD10Hierarchy`` class have been removed (their
  functionality was replaced by the :mod:`.hierarchy` module)
* The :func:`.processing_functions.removeIfSparse` and
  :func:`.processing_functions_core.removeIfSparse` functions no longer accept
  an ``absolute`` argument.



Paul McCarthy's avatar
Paul McCarthy committed
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
0.21.1 (Thursday 8th May 2019)
------------------------------


Changed
^^^^^^^


* Addd categories 1, 2 and 99 to the ``fmrib`` configuration.



Paul McCarthy's avatar
Paul McCarthy committed
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
0.21.0 (Thursday 8th May 2019)
------------------------------


Added
^^^^^


* :class:`.Column` objects now have a ``metadata`` attribute which may be used
  in the column description (if the ``--description_file`` option is used).
  Processing functions can set the metadata for newly added columns.
* New ``metaproc`` plugin type to manipulate column metadata.
* All processing functions accept a ``metaproc`` argument, allowing a
  ``metaproc`` function to be applied to any column metadata that is returned
  by the processing function..


Changed
^^^^^^^


1092
1093
* The :func:`.processing_functions.binariseCategorical` function sets the
  categorical value as column metadata on the new binarised columns.
Paul McCarthy's avatar
Paul McCarthy committed
1094
1095


Paul McCarthy's avatar
Paul McCarthy committed
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
0.20.1 (Wednesday 8th May 2019)
-------------------------------


Fixed
^^^^^


* Fixed some typos in the ``README`` file.


Paul McCarthy's avatar
Paul McCarthy committed
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
0.20.0 (Tuesday 7th May 2019)
-----------------------------


Added
^^^^^


* The :func:`.isSparse` and :func:`.removeIfSparse` functions accept
  a new option, ``mincat``, which allows a categorical to be deemed sparse
  if the size of its smallest category is below a given threshold.
Paul McCarthy's avatar
Paul McCarthy committed
1118
1119
* New ``--description_file`` option which, for UK BioBank data, saves the
  description for each column to a text file.
Paul McCarthy's avatar
Paul McCarthy committed
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132


Changed
^^^^^^^


* The ``absolute`` parameter to the :func:`.isSparse` and
  :func:`.removeIfSparse` functions is deprecated. Instead, they now accept
  ``abspres`` and ``abscat`` arguments, allowing the
  absoluteness/proportionality of the ``minpres`` and ``mincat``/``maxcat``
  options to be specified separately.
* Changed default processing rules so that ICD10 variables undergo a slightly
  different sparsity test.
Paul McCarthy's avatar
Paul McCarthy committed
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143


Fixed
^^^^^


* Fixed a bug in the categorical recoding rules for Data Coding `100012
  <https://biobank.ctsu.ox.ac.uk/crystal/coding.cgi?id=100012>`_.



Paul McCarthy's avatar
Paul McCarthy committed
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
0.19.2 (Friday 26th April 2019)
-------------------------------


Changed
^^^^^^^


* Changes to built-in categories and to ``fmrib`` configuration.


Paul McCarthy's avatar
Paul McCarthy committed
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
0.19.1 (Thursday 25th April 2019)
---------------------------------


Changed
^^^^^^^


* Changed the default processing rules for ICD10 variables 40001, 40002,
  40006, 41202, and 41204.
* Added ICD10 variables 41201 and 41270 to the default cleaning/processing
  rules.


Paul McCarthy's avatar
Paul McCarthy committed
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
0.19.0 (Wednesday 24th April 2019)
----------------------------------


Added
^^^^^


* The ``--column`` option now accepts a file which contains a list of column
  names to import.


Changed
^^^^^^^


* The :func:`.icd10.codeToNumeric` and :func:`.icd10.numericToCode` functions
  have been changed to use the integer node IDs in the ICD10 hierarchy
  file. The previous approach could not handle parent categories, nor a small
  number of ICD10 codes which do not have a ``<letter><number>`` structure.
* The :func:`.fileinfo.has_header` function has been made more lenient for
  files with a small number of columns.


Paul McCarthy's avatar
Paul McCarthy committed
1193
0.18.0 (Tuesday 23rd April 2019)
Paul McCarthy's avatar
Paul McCarthy committed
1194
1195
1196
--------------------------------


Paul McCarthy's avatar
Paul McCarthy committed
1197
1198
1199
1200
1201
1202
1203
1204
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
1205
1206
1207
1208
Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
1209
1210
1211
* 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
1212
1213
1214
1215
* 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
1216
1217
1218
* The :func:`.isSparse` function now returns the reason and value for
  columns which fail the sparsity test.

Paul McCarthy's avatar
Paul McCarthy committed
1219
1220


Paul McCarthy's avatar
Paul McCarthy committed
1221
0.17.0 (Monday 22nd April 2019)
Paul McCarthy's avatar
Paul McCarthy committed
1222
1223
1224
1225
1226
1227
1228
1229
1230
-------------------------------


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
1231
1232
* Built-in ``fmrib.cfg`` configuration file, which can be used via
  ``-cfg fmrib``.
Paul McCarthy's avatar
Paul McCarthy committed
1233
1234
1235
1236
1237
1238
1239
1240
1241


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
1242
* Built-in categories have been updated.
Paul McCarthy's avatar
Paul McCarthy committed
1243
1244
1245
1246
1247
1248
1249
1250


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
1251
  between column names for different ICD10 codes.
Paul McCarthy's avatar
Paul McCarthy committed
1252
1253


Paul McCarthy's avatar
Paul McCarthy committed
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
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
1280
1281
1282
1283
1284
1285
Removed
^^^^^^^


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

Paul McCarthy's avatar
Paul McCarthy committed
1286

Paul McCarthy's avatar
Paul McCarthy committed
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
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
1298
1299
0.15.0 (Monday 18th March 2019)
-------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310


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
1311
1312
* Definitions for all hierarchical UK Biobank variables are located in the
  ``ukbparse/data/hierarchy/`` directory.
Paul McCarthy's avatar
Paul McCarthy committed
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324


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
1325
1326
1327
1328
1329
1330
1331
1332
0.14.8 (Monday 18th March 2019)
-------------------------------


Fixed
^^^^^


1333
1334
* Fixed an issue with the :func:`.processing_functions.binariseCategorical`
  processing function being applied to ICD10 codes.
Paul McCarthy's avatar
Paul McCarthy committed
1335

Paul McCarthy's avatar
Paul McCarthy committed
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348

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
1349
1350
0.14.6 (Saturday 16th March 2019)
---------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
1351
1352
1353
1354
1355
1356
1357
1358
1359


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
1360
1361
* Fixed some issues introduced by behavioural changes in the
  ``pandas.HDFStore`` class.
Paul McCarthy's avatar
Paul McCarthy committed
1362
1363


Paul McCarthy's avatar
Paul McCarthy committed
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
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
1376
1377
1378
1379
1380
1381
1382
1383
1384
0.14.4 (Friday 11th January 2019)
---------------------------------


Changed
^^^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
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
1400
1401
1402
1403
1404
1405
1406
1407
0.14.2 (Monday 7th January 2019)
--------------------------------


Fixed
^^^^^


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

Paul McCarthy's avatar
Paul McCarthy committed
1411

Paul McCarthy's avatar
Paul McCarthy committed
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
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
1428
1429
0.14.0 (Tuesday 25th December 2018)
-----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
1430
1431
1432
1433
1434
1435


Added
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
1436
1437
* New ``--column`` option, allowing columns to be selected by name/name
  pattern.
Paul McCarthy's avatar
Paul McCarthy committed
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
* ``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
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460

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
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470


Added
^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
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
1481
1482
* 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
1483
1484


Paul McCarthy's avatar
Paul McCarthy committed
1485
1486
1487
1488
1489
1490
1491
Fixed
^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
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
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
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
1515
1516
0.12.1 (Saturday 15th December 2018)
------------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535


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
1536
* Added ``lxml`` as a dependency (required by ``beautifulsoup4``).
Paul McCarthy's avatar
Paul McCarthy committed
1537
1538


Paul McCarthy's avatar
Paul McCarthy committed
1539
1540
0.12.0 (Tuesday 11th December 2018)
-----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
1541
1542
1543
1544
1545
1546
1547
1548
1549


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
1550
1551
1552
* 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
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568


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
1569
1570
* Fixed mixed data type issues when merging the data coding and type tables into
  the variable table.
Paul McCarthy's avatar
Paul McCarthy committed
1571

Paul McCarthy's avatar
Paul McCarthy committed
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585

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
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
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
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
0.11.1 (Monday 10th December 2018)
----------------------------------


Fixed
^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
1610
1611
0.11.0 (Monday 10th December 2018)
----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
1612
1613
1614
1615
1616
1617
1618
1619


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
1620
1621
1622
* 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
1623
1624


Paul McCarthy's avatar
Paul McCarthy committed
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
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
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
0.10.4 (Friday 7th December 2018)
---------------------------------


Fixed
^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
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
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
0.10.2 (Friday 7th December 2018)
---------------------------------


Fixed
^^^^^


* Removed relative imports from test modules.


Paul McCarthy's avatar
Paul McCarthy committed
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
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
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
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
1695
1696
* ``--dry_run`` mode now prints information about columns that would not be
  loaded.
Paul McCarthy's avatar
Paul McCarthy committed
1697
1698


Paul McCarthy's avatar
Paul McCarthy committed
1699
1700
1701
1702
1703
1704
Fixed
^^^^^


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

Paul McCarthy's avatar
Paul McCarthy committed
1705

Paul McCarthy's avatar
Paul McCarthy committed
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
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
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
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
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
0.7.1
-----


Fixed
^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
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
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
0.6.3
-----


Changed
^^^^^^^


* Minor updates to avoid deprecation warnings.


Paul McCarthy's avatar
Paul McCarthy committed
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
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
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
0.6.1
-----


Changed
^^^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
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
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
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
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
0.4.1
-----


Changed
^^^^^^^


* Updates to variable table for UKBiobank spirometry variables.


Paul McCarthy's avatar
Paul McCarthy committed
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
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
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
0.3.3
-----


Changed
^^^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
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
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
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
^^^^^


1916
1917
* The :func:`.processing_functions.binariseCategorical` function now works on
  data with missing values.
Paul McCarthy's avatar
Paul McCarthy committed
1918
1919


Paul McCarthy's avatar
Paul McCarthy committed
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
0.3.0
-----


Added
^^^^^


* New :meth:`.DataTable.addColumns` method, so processing functions can
  now add new columns.
1930
1931
1932
1933
1934
1935
* New :func:`.processing_functions.binariseCategorical` processing function,
  which expands a categorical column into multiple binary columns, one for
  each unique value in the data.
* New :func:`.processing_functions.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
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
* Keyword arguments can now be used when specifying processing.


Fixed
^^^^^


* Fixed handling of non-numeric categorical variables


Paul McCarthy's avatar
Paul McCarthy committed
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
0.2.0
-----


Added
^^^^^

* Added a changelog file


Changed
^^^^^^^


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