Skip to content

Commit

Permalink
small clean ups
Browse files Browse the repository at this point in the history
  • Loading branch information
TomDonoghue committed Jun 29, 2023
1 parent 00ace93 commit cee5001
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
5 changes: 3 additions & 2 deletions fooof/objs/fit.py
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ def report(self, freqs=None, power_spectrum=None, freq_range=None, plt_log=False
plt_log : bool, optional, default: False
Whether or not to plot the frequency axis in log space.
**plot_kwargs
Keyword arguments to pass into the plot method.
Keyword arguments to pass into the plot method.
Notes
-----
Expand Down Expand Up @@ -650,7 +650,8 @@ def plot(self, plot_peaks=None, plot_aperiodic=True, plt_log=False,


@copy_doc_func_to_method(save_report_fm)
def save_report(self, file_name, file_path=None, plt_log=False, add_settings=True, **plot_kwargs):
def save_report(self, file_name, file_path=None, plt_log=False,
add_settings=True, **plot_kwargs):

save_report_fm(self, file_name, file_path, plt_log, add_settings, **plot_kwargs)

Expand Down
13 changes: 8 additions & 5 deletions fooof/objs/group.py
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,8 @@ def print_results(self, concise=False):
print(gen_results_fg_str(self, concise))


def save_model_report(self, index, file_name, file_path=None, plt_log=False, **plot_kwargs):
def save_model_report(self, index, file_name, file_path=None, plt_log=False,
add_settings=True, **plot_kwargs):
""""Save out an individual model report for a specified model fit.
Parameters
Expand All @@ -555,14 +556,16 @@ def save_model_report(self, index, file_name, file_path=None, plt_log=False, **p
Path to directory to save to. If None, saves to current directory.
plt_log : bool, optional, default: False
Whether or not to plot the frequency axis in log space.
add_settings : bool, optional, default: True
Whether to add a print out of the model settings to the end of the report.
plot_kwargs : keyword arguments
Keyword arguments to pass into the plot method.
"""

self.get_fooof(ind=index, regenerate=True).save_report(file_name, file_path, plt_log, **plot_kwargs)


self.get_fooof(ind=index, regenerate=True).save_report(\
file_name, file_path, plt_log, **plot_kwargs)


def to_df(self, peak_org):
"""Convert and extract the model results as a pandas object.
Expand Down

0 comments on commit cee5001

Please sign in to comment.