CHANGELOG.rst 38.3 KB
Newer Older
Paul McCarthy's avatar
Paul McCarthy committed
1
2
FUNPACK changelog
=================
Paul McCarthy's avatar
Paul McCarthy committed
3
4


Paul McCarthy's avatar
Paul McCarthy committed
5
6
7
8
9
10
11
12
13
14
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
15
16
17
18
19
20


Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
21
22
23
* Conditional expressions used with the ``--subject`` option can now be used
  on date/time variables.
* Internal re-organisation of the ``funpack.fileinfo`` module.
Paul McCarthy's avatar
Paul McCarthy committed
24
25


Paul McCarthy's avatar
Paul McCarthy committed
26
27
28
29
30
31
32
33
34
35
36
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
37
38
39
40
41
42
43


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
44
45
46
47
48
* 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
49
50


Paul McCarthy's avatar
Paul McCarthy committed
51
52
53
54
55
56
57
58
59
60
61
2.3.3 (Wednesday 5th October 2020)
----------------------------------


Changed
^^^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
62
63
64
65
66
67
68
69
70
71
72
73
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
74
75
2.3.1 (Sunday 17th May 2020)
----------------------------
Paul McCarthy's avatar
Paul McCarthy committed
76
77


Paul McCarthy's avatar
Paul McCarthy committed
78
79
80
81
82
83
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
84
  to parallelise calls across variables (!64).
Paul McCarthy's avatar
Paul McCarthy committed
85
86


Paul McCarthy's avatar
Paul McCarthy committed
87
88
89
90
91
Fixed
^^^^^


* The improved :mod:`.fmrib` date/time normalisation routines were not
Paul McCarthy's avatar
Paul McCarthy committed
92
93
94
  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
95
96


Paul McCarthy's avatar
Paul McCarthy committed
97
98
2.3.0 (Tuesday 12th May 2020)
-----------------------------
Paul McCarthy's avatar
Paul McCarthy committed
99
100
101
102
103
104
105
106


Changed
^^^^^^^


* Modified the :func:`.binariseCategorical` function so that it parallelises
  tasks internally, instead of being called in parallel for different
Paul McCarthy's avatar
Paul McCarthy committed
107
  variables. This should give superior performance (!60).
Paul McCarthy's avatar
Paul McCarthy committed
108
* Revisited the :meth:`.DataTable.merge` to optimise performance in all
Paul McCarthy's avatar
Paul McCarthy committed
109
  scenarios (!60).
Paul McCarthy's avatar
Paul McCarthy committed
110
111
112
113
* 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
114
  a numeric type), and will improve data export performance (!60, !61).
Paul McCarthy's avatar
Paul McCarthy committed
115
116


Paul McCarthy's avatar
Paul McCarthy committed
117
118
119
120
121
122
123
124
125
126
127
128
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
129
130
2.2.0 (Friday 1st May 2020)
---------------------------
Paul McCarthy's avatar
Paul McCarthy committed
131
132
133
134
135
136


Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
137
138
139
* Substantial performance improvements to the :func:`.codeToNumeric` cleaning
  function, and to :func:`.removeIfRedundant`, :func:`.binariseCategorical`,
  and other processing functions.
Paul McCarthy's avatar
Paul McCarthy committed
140
141
142
143
144
145
* The default implementation of :func:`.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
  dependency, for setting the number of threads to use when parallelising
  ``numpy`` operations.
Paul McCarthy's avatar
Paul McCarthy committed
146
147
148
149
150
151
152
153


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
154
155
* :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
156
157


Paul McCarthy's avatar
Paul McCarthy committed
158
159
160
161
162
163
164
165
166
167
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
168
169
170
171
172
173
174
175
176


Changed
^^^^^^^


* Internal changes to improve performance.


Paul McCarthy's avatar
Paul McCarthy committed
177
2.0.0 (Tuesday 7th April 2020)
Paul McCarthy's avatar
Paul McCarthy committed
178
------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
179
180


Paul McCarthy's avatar
Paul McCarthy committed
181
182
183
184
Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
185
186
187
* 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
188
189
190
191
* 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
192
193
* 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
194
195
196
197
198
199
200
201
* 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
202
203
204
205
206
207
208
209
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
210
211
* Removed the unused :mod:`funpack.storage` module.
* Removed the unused :meth:`.DataTable.order` method.
Paul McCarthy's avatar
Paul McCarthy committed
212
213


Paul McCarthy's avatar
Paul McCarthy committed
214
215
216
217
218
219
220
221
222
223
224
1.9.1 (Sunday 29th March 2020)
------------------------------


Changed
^^^^^^^


* Updates to FMRIB categories.


Paul McCarthy's avatar
Paul McCarthy committed
225
226
1.9.0 (Friday 28th February 2020)
---------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241


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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
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
258
259
260
Deprecated
^^^^^^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
261

Paul McCarthy's avatar
Paul McCarthy committed
262
263
264
265
266
* 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
267
268
269
270
271
272
273
274
1.8.2 (Monday 24th February 2020)
---------------------------------


Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
275
276
277
* 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).
Paul McCarthy's avatar
Paul McCarthy committed
278
279
280
281
* Changed the way that the :func:`.removeIfRedundant`  process splits up
  the data set for parallel processing.


Paul McCarthy's avatar
Paul McCarthy committed
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
1.8.1 (Wednesday 19th February 2020)
------------------------------------


Added
^^^^^


* New ``naval`` option to the :func:`.removeIfSparse` processing function.


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
301
302
1.8.0 (Tuesday 18th February 2020)
----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
303
304
305
306
307
308
309
310
311


Added
^^^^^


* New ``take`` option to the :func:`.binariseCategorical` processing function,
  which allows the generated columns to contain values from another column,
  instead of containing binary labels.
Paul McCarthy's avatar
Paul McCarthy committed
312
313
314
315
316
317
318
319
320
* New ``fillval`` option to the :func:`.binariseCategorical` processing
  function, which can be used in conjunction with ``take``, to specify the
  fill value for missing rows.
* 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
321
322


Paul McCarthy's avatar
Paul McCarthy committed
323
324
325
326
Changed
^^^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
327
328
329
330
331
332
333
* 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
334
335
336
337
338
339
* 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
340
341
342
343
344
345
346
347
348
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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
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
368
369
1.7.0 (Friday 24th January 2020)
--------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
370
371
372
373
374
375
376
377
378
379


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
380
381
382
383
384
385
386
387
388
389
390
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
391
* The :func:`.removeIfRedundant` processsing function will now drop columns
Paul McCarthy's avatar
Paul McCarthy committed
392
393
394
395
396
397
398
  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
399
400
401
402
403
404
405
406


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
407
408


Paul McCarthy's avatar
Paul McCarthy committed
409
410
1.6.0 (Wednesday 11th December 2019)
------------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
411
412
413
414
415
416
417
418
419
420
421
422
423


Added
^^^^^


* Non-numeric variables can now be used in conditional expressions, e.g.
  ``'v41202 == "A009"'`. Within such expressions, the value must be contained
  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
424
425
426
427
428
429
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
430
431
432
* 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
433
434


Paul McCarthy's avatar
Paul McCarthy committed
435
436
1.5.0 (Monday 9th December 2019)
--------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
437
438
439
440
441
442


Added
^^^^^


Paul McCarthy's avatar
Paul McCarthy committed
443
* New :func:`.util.wc` function to count the rows (lines) of a file;
Paul McCarthy's avatar
Paul McCarthy committed
444
  this is simply a wrapper around the UNIX ``wc`` tool.
Paul McCarthy's avatar
Paul McCarthy committed
445
446
* 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
447
448
* 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
449
450
451
452
* 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
453
454
* 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
455
456
  multiple columns for one variable. These can be used with the ``--subject``
  option.
Paul McCarthy's avatar
Paul McCarthy committed
457
458
459
460
461
462
463


Changed
^^^^^^^


* FUNPACK will now parallelise tasks by default; previously it would only
Paul McCarthy's avatar
Paul McCarthy committed
464
465
466
467
468
469
470
471
472
473
474
475
476
  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
477
478
* The ``--variable``, ``--subject`` and ``--exclude`` options now accept
  comma-separated mixtures of IDs and MATLAB-style ranges.
Paul McCarthy's avatar
Paul McCarthy committed
479
480
481
482
* 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
483
  context. This is not necessary when ``funpack`` is configured to not
Paul McCarthy's avatar
Paul McCarthy committed
484
  parallelise tasks (e.g. with ``--num_jobs 1``).
Paul McCarthy's avatar
Paul McCarthy committed
485
486
487
488
489
490
491


Deprecated
^^^^^^^^^^


* The ``--low_memory`` and ``--work_dir`` options have been deprecated, and no
Paul McCarthy's avatar
Paul McCarthy committed
492
493
  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
494
495
496
497


1.4.5 (Thursday 5th December 2019)
----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
498
499


Paul McCarthy's avatar
Paul McCarthy committed
500
501
502
503
504
505
506
507
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
508
509
510
511
512
513
514
515
516
Fixed
^^^^^


* 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
517
518
519
520
521
522
523
524
525
526
527
1.4.4 (Friday 15th November 2019)
---------------------------------


Changed
^^^^^^^


* Updates to the FMRIB categories and configuration.


Paul McCarthy's avatar
Paul McCarthy committed
528
529
530
531
532
533
534
535
536
537
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
538
* Increased the file sample size used by :func:`.fileinfo.sniff`.
Paul McCarthy's avatar
Paul McCarthy committed
539

Paul McCarthy's avatar
Paul McCarthy committed
540
541
542
543
544
545
546
547
548
549
550
551

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


Changed
^^^^^^^


* Minor changes to the FMRIB configuration.


Paul McCarthy's avatar
Paul McCarthy committed
552
1.4.1 (Monday 8th July 2019)
Paul McCarthy's avatar
Paul McCarthy committed
553
----------------------------
Paul McCarthy's avatar
Paul McCarthy committed
554
555
556
557
558
559
560
561
562
563
564
565


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
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
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
  variable :ref:`20003
  <https://biobank.ctsu.ox.ac.uk/crystal/field.cgi?id=20003>`_. This column is
  initially populated from ``funpack/data/type.txt``.
* New :mod:`funpack.coding` module, for retrieving descriptive information
  about data codings. The information is stored in the
  ``funpack/data/coding/``directory.  Hierarchical data codings are still
  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
  :func:`.codeToNumeric` cleaning function - the coding is automatically looked
  up.
* 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
620
621
622
623
624
625
626
627
628
629
630
1.3.2 (Tuesday 4th June 2019)
-----------------------------


Changed
^^^^^^^


* Minor adjustments to the FMRIB categories.


Paul McCarthy's avatar
Paul McCarthy committed
631
632
633
634
635
636
637
638
639
640
641
1.3.1 (Thursday 30th May 2019)
------------------------------


Changed
^^^^^^^


* Updates to documentation.


Paul McCarthy's avatar
Paul McCarthy committed
642
643
644
645
646
647
648
649
650
651
652
653
1.3.0 (Wednesday 29th May 2019)
-------------------------------


Added
^^^^^


* New :func:`.codeToNumeric` cleaning function, for transforming hierarhical
  variable codes.
* New :func:`.hierarchy.codeToNumeric` and
  :func:`.hierarchy.numericToCode` functions.
Paul McCarthy's avatar
Paul McCarthy committed
654
655
* New meta-process functions for generating descriptions for ICD9, OPCS3 and
  OPCS4 hierarchical variables.
Paul McCarthy's avatar
Paul McCarthy committed
656
657
658
659
* 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
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674


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
675
676
677
678
679
680
681
682
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
683
684
685
686
687
688
689
690
691
692
693
694
695
696
Deprecated
^^^^^^^^^^


* The :func:`.convertICD10Codes` cleaning function has been replaced by
  the new :func:`.codeToNumeric` function, which can be used with any
  hierarchical variable.
* 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
697
698
699
700
701
702
703
704
705
706
707
1.2.1 (Tuesday 28th May 2019)
-----------------------------


Changed
^^^^^^^


* Minor changes to built-in variable categories.


Paul McCarthy's avatar
Paul McCarthy committed
708
1.2.0 (Saturday 25th May 2019)
Paul McCarthy's avatar
Paul McCarthy committed
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
------------------------------


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
725
  been revised and updated.
Paul McCarthy's avatar
Paul McCarthy committed
726
727


Paul McCarthy's avatar
Paul McCarthy committed
728
729
730
731
732
733
734
735
736
737
738
739
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
740
741
742
743
744
745
746
747

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


Changed
^^^^^^^

Paul McCarthy's avatar
Paul McCarthy committed
748

Paul McCarthy's avatar
Paul McCarthy committed
749
750
* 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
751
  to the number of *non-missing* data points, rather than the total number of
Paul McCarthy's avatar
Paul McCarthy committed
752
753
754
  data points.


Paul McCarthy's avatar
Paul McCarthy committed
755
756
757
758
759
760
761
762
763
764
765
766
767
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
768
769
770
771
772
773
774
775
776
777
778
-------------------------------


Fixed
^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
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
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
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
814
815
816
817
818
819
820
821
822
823
824
825

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
826
827
828
829
830
831
832
833
834
835
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
836

Paul McCarthy's avatar
Paul McCarthy committed
837

Paul McCarthy's avatar
Paul McCarthy committed
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
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
853
854
855
856
857
858
859
860
861
862
863
864
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
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
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
^^^^^^^


* The :func:`.binariseCategorical` function sets the categorical value as
  column metadata on the new binarised columns.


Paul McCarthy's avatar
Paul McCarthy committed
890
891
892
893
894
895
896
897
898
899
900
0.20.1 (Wednesday 8th May 2019)
-------------------------------


Fixed
^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
901
902
903
904
905
906
907
908
909
910
911
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
912
913
* 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
914
915
916
917
918
919
920
921
922
923
924
925
926


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
927
928
929
930
931
932
933
934
935
936
937


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
938
939
940
941
942
943
944
945
946
947
948
0.19.2 (Friday 26th April 2019)
-------------------------------


Changed
^^^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
949
950
951
952
953
954
955
956
957
958
959
960
961
962
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
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
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
987
0.18.0 (Tuesday 23rd April 2019)
Paul McCarthy's avatar
Paul McCarthy committed
988
989
990
--------------------------------


Paul McCarthy's avatar
Paul McCarthy committed
991
992
993
994
995
996
997
998
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
999
1000
Changed
^^^^^^^