Skip to content

[ENH] - Add and use group_to_dict function #279

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

Merged
TomDonoghue merged 1 commit into from
Jul 8, 2023
Merged

[ENH] - Add and use group_to_dict function #279

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
28 changes: 27 additions & 1 deletion fooof/data/conversions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,32 @@ def model_to_dataframe(fit_results, peak_org):
return pd.Series(model_to_dict(fit_results, peak_org))


def group_to_dict(fit_results, peak_org):
"""Convert a group of model fit results into a dictionary.

Parameters
----------
fit_results : list of FOOOFResults
List of FOOOFResults objects.
peak_org : int or Bands
How to organize peaks.
If int, extracts the first n peaks.
If Bands, extracts peaks based on band definitions.

Returns
-------
dict
Model results organized into a dictionary.
"""

fr_dict = {ke : [] for ke in model_to_dict(fit_results[0], peak_org).keys()}
for f_res in fit_results:
for key, val in model_to_dict(f_res, peak_org).items():
fr_dict[key].append(val)

return fr_dict


@check_dependency(pd, 'pandas')
def group_to_dataframe(fit_results, peak_org):
"""Convert a group of model fit results into a dataframe.
Expand All @@ -103,4 +129,4 @@ def group_to_dataframe(fit_results, peak_org):
Model results organized into a dataframe.
"""

return pd.DataFrame([model_to_dataframe(f_res, peak_org) for f_res in fit_results])
return pd.DataFrame(group_to_dict(fit_results, peak_org))
11 changes: 11 additions & 0 deletions fooof/tests/data/test_conversions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,17 @@ def test_model_to_dataframe(tresults, tbands, skip_if_no_pandas):
out = model_to_dataframe(tresults, peak_org=tbands)
assert isinstance(out, pd.Series)

def test_group_to_dict(tresults, tbands):

fit_results = [deepcopy(tresults), deepcopy(tresults), deepcopy(tresults)]

for peak_org in [1, 2, 3]:
out = group_to_dict(fit_results, peak_org=peak_org)
assert isinstance(out, dict)

out = group_to_dict(fit_results, peak_org=tbands)
assert isinstance(out, dict)

def test_group_to_dataframe(tresults, tbands, skip_if_no_pandas):

fit_results = [deepcopy(tresults), deepcopy(tresults), deepcopy(tresults)]
Expand Down