Skip to content

FIX: Make confound expansion column order deterministic #1045

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lobennett wants to merge 1 commit into
base: master
Choose a base branch
from
Open

FIX: Make confound expansion column order deterministic #1045

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions niworkflows/interfaces/confounds.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,7 @@ def temporal_derivatives(order, variables, data):
if 0 in order:
data_deriv[0] = data[variables]
variables_deriv[0] = variables
order = set(order) - {0}
order = sorted(set(order) - {0})
for o in order:
variables_deriv[o] = [f'{v}_derivative{o}' for v in variables]
data_deriv[o] = np.tile(np.nan, data[variables].shape)
Expand Down Expand Up @@ -542,7 +542,7 @@ def exponential_terms(order, variables, data):
if 1 in order:
data_exp[1] = data[variables]
variables_exp[1] = variables
order = set(order) - {1}
order = sorted(set(order) - {1})
for o in order:
variables_exp[o] = [f'{v}_power{o}' for v in variables]
data_exp[o] = data[variables] ** o
Expand Down Expand Up @@ -690,7 +690,8 @@ def _expand_shorthand(model_formula, variables):
model_formula = model_formula.replace('spikes', spikes)

formula_variables = _get_variables_from_formula(model_formula)
others = ' + '.join(set(variables) - set(formula_variables))
formula_set = set(formula_variables)
others = ' + '.join(v for v in variables if v not in formula_set)
model_formula = model_formula.replace('others', others)
return model_formula

Expand Down Expand Up @@ -787,7 +788,7 @@ def parse_formula(model_formula, parent_data, unscramble=False):
)
else:
(variables[expression], data[expression]) = parse_expression(expression, parent_data)
variables = list(set(reduce(operator.add, variables.values())))
variables = list(dict.fromkeys(reduce(operator.add, variables.values())))
data = pd.concat((data.values()), axis=1)

if unscramble:
Expand Down
24 changes: 24 additions & 0 deletions niworkflows/tests/test_confounds.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,30 @@ def test_expansion_na_robustness(datadir):
pd.testing.assert_series_equal(expected_data[col], exp_data[col], check_dtype=False)


def test_expansion_column_order_deterministic(datadir):
"""Column order is deterministic across runs (regression for nipreps/fmriprep#3501)."""
model_formula = '(dd1(a + b + c))^^2 + others'
expected_columns = [
'a',
'a_derivative1',
'a_power2',
'a_derivative1_power2',
'b',
'b_derivative1',
'b_power2',
'b_derivative1_power2',
'c',
'c_derivative1',
'c_power2',
'c_derivative1_power2',
'd',
'e',
'f',
]
exp_data = _expand_test(model_formula, datadir)
assert list(exp_data.columns) == expected_columns


def test_spikes(datadir):
"""Test outlier flagging"""
outliers = [1, 1, 0, 0, 1]
Expand Down
Loading