fmrib-unpack 1.4.1

安装

通过PIP安装Funpack:

pip install fmrib-unpack

或来自conda-forge：

conda install -c conda-forge fmrib-unpack

入门笔记本

funpack_demo命令将启动一个jupyter笔记本，其中介绍 Funpack提供的主要功能。要运行它，您需要安装一些 其他依赖项：

pip install fmrib-unpack[demo]

source $FSLDIR/fslpython/bin/activate fslpython
pip install fmrib-unpack[demo]

然后，可以通过运行funpack_demo启动演示。

用法

一般用法如下：

funpack [options] output.tsv input1.tsv input2.tsv

您可以通过键入funpack --help获得所有选项的信息。

选项可以在命令行中指定，和/或存储在配置中 文件。例如，以下命令行中的选项：

funpack \
  --overwrite \
  --import_all \
  --log_file log.txt \
  --icd10_map_file icd_codes.tsv \
  --category 10 \
  --category 11 \
  output.tsv input1.tsv input2.tsv

可以存储在配置文件config.txt：

overwrite
import_all
log_file       log.txt
icd10_map_file icd_codes.tsv
category       10
category       11

然后执行如下操作：

funpack -cfg config.txt output.tsv input1.tsv input2.tsv

功能

Funpack允许您执行各种数据清理和处理步骤 关于您的数据，例如：

• NA value replacement: Specific values for some columns can be replaced with NA, for example, variables where a value of -1 indicates Do not know.
• Categorical recoding: Certain categorical columns can re-coded. For example, variables where a value of 555 represents half can be recoded so that 555 is replaced with 0.5.
• Child value replacement: NA values within some columns which are dependent upon other columns may have values inserted based on the values of their parent columns.

有关功能的更全面概述，请参阅介绍性笔记本 在Funpack中提供。

内置规则

Funpack包含大量的内置规则 写入预处理英国生物银行数据变量。这些规则存储在 以下文件：

• ^{tt7}$: Cleaning rules for data codings
• ^{tt8}$: Cleaning rules for individual variables
• ^{tt9}$: Processing steps
• ^{tt10}$: Variable categories

您可以使用fmrib配置文件来使用这些规则：

funpack -cfg fmrib output.tsv input.tsv

您可以根据需要自定义或替换这些文件。你也可以通过 通过--variable_file将这些文件的您自己的版本发送到Funpack， --datacoding_file、--type_file、--processing_file和 --category_file命令行选项。Funpack将加载所有 变量和数据编码文件，并将它们合并到单个表中 包含每个变量的清理规则。

输出

Funpack的主要输出是一个纯文本制表符分隔的[*]\ 包含在清理和处理之后的输入数据，可能是 删除了一些列，添加了新列。

如果使用--non_numeric_file选项，则主输出文件将仅 包含数字列；非数字列将保存到单独的 文件。

您可以使用自己选择的任何工具加载此输出文件，例如python， Matlab或Excel。也可以将输出传递回 功能包。

data = readtable('out.tsv', 'FileType', 'text');

data    = data(:, vartype('numeric'));
rawdata = data.Variables;

colnames        = data.Properties.VariableDescriptions;
colnames        = regexp(colnames, '''(.+)''', 'tokens', 'once');
empty           = cellfun(@isempty, colnames);
colnames(empty) = data.Properties.VariableNames(empty);
colnames        = vertcat(colnames{:});

descs = readtable('descriptions.tsv', ...
                  'FileType', 'text', ...
                  'Delimiter', '\t',  ...
                  'ReadVariableNames',false);
descs = [descs; {'eid', 'ID'}];
idxs  = cellfun(@(x) find(strcmp(descs.Var1, x)), colnames, ...
                'UniformOutput', false);
idxs  = cell2mat(idxs);
descs = descs.Var2(idxs);

测试

要运行测试套件，您需要安装一些附加依赖项：

pip install fmrib-unpack[test]

然后可以使用pytest：

pytest

引用

如果你想引用Funpack，请参考它的Zenodo page。