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


Paul McCarthy's avatar
Paul McCarthy committed
5
6
0.11.0 (Monday 10th December 2018)
----------------------------------
Paul McCarthy's avatar
Paul McCarthy committed
7
8
9
10
11
12
13
14


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
15
16
17
* 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
18
19


Paul McCarthy's avatar
Paul McCarthy committed
20
21
22
23
24
25
26
27
28
29
30
31
32
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
33
34
35
36
37
38
39
40
41
42
43
0.10.4 (Friday 7th December 2018)
---------------------------------


Fixed
^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
44
45
46
47
48
49
50
51
52
53
54
55
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
56
57
58
59
60
61
62
63
64
65
66
0.10.2 (Friday 7th December 2018)
---------------------------------


Fixed
^^^^^


* Removed relative imports from test modules.


Paul McCarthy's avatar
Paul McCarthy committed
67
68
69
70
71
72
73
74
75
76
77
78
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
79
80
81
82
83
84
85
86
87
88
89
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
90
91
* ``--dry_run`` mode now prints information about columns that would not be
  loaded.
Paul McCarthy's avatar
Paul McCarthy committed
92
93


Paul McCarthy's avatar
Paul McCarthy committed
94
95
96
97
98
99
Fixed
^^^^^


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

Paul McCarthy's avatar
Paul McCarthy committed
100

Paul McCarthy's avatar
Paul McCarthy committed
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
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
119
120
121
122
123
124
125
126
127
128
129
130
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
131
132
133
134
135
136
137
138
139
140
141
0.7.1
-----


Fixed
^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
142
143
144
145
146
147
148
149
150
151
152
153
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
154
155
156
157
158
159
160
161
162
163
164
0.6.3
-----


Changed
^^^^^^^


* Minor updates to avoid deprecation warnings.


Paul McCarthy's avatar
Paul McCarthy committed
165
166
167
168
169
170
171
172
173
174
175
176
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
177
178
179
180
181
182
183
184
185
186
187
188
0.6.1
-----


Changed
^^^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
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
239
240
241
242
243
244
245
246
247
248
249
0.4.1
-----


Changed
^^^^^^^


* Updates to variable table for UKBiobank spirometry variables.


Paul McCarthy's avatar
Paul McCarthy committed
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
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
271
272
273
274
275
276
277
278
279
280
281
0.3.3
-----


Changed
^^^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
282
283
284
285
286
287
288
289
290
291
292
293
294
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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
0.3.1
-----


Changed
^^^^^^^


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


Fixed
^^^^^


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


Paul McCarthy's avatar
Paul McCarthy committed
315
316
317
318
319
320
321
322
323
324
325
326
327
0.3.0
-----


Added
^^^^^


* New :meth:`.DataTable.addColumns` method, so processing functions can
  now add new columns.
* New :func:`.binariseCategorical` processing function, which expands a
  categorical column into multiple binary columns, one for each unique
  value in the data.
Paul McCarthy's avatar
Paul McCarthy committed
328
329
* New :func:`.expandCompound` processing function, which expands a
  compound column into columns, one for each value in the compound data.
Paul McCarthy's avatar
Paul McCarthy committed
330
331
332
333
334
335
336
337
338
339
* Keyword arguments can now be used when specifying processing.


Fixed
^^^^^


* Fixed handling of non-numeric categorical variables


Paul McCarthy's avatar
Paul McCarthy committed
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
0.2.0
-----


Added
^^^^^

* Added a changelog file


Changed
^^^^^^^


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