Skip to content

Commit cee5001

Browse files
committed
small clean ups
1 parent 00ace93 commit cee5001

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

fooof/objs/fit.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,7 @@ def report(self, freqs=None, power_spectrum=None, freq_range=None, plt_log=False
393393
plt_log : bool, optional, default: False
394394
Whether or not to plot the frequency axis in log space.
395395
**plot_kwargs
396-
Keyword arguments to pass into the plot method.
396+
Keyword arguments to pass into the plot method.
397397
398398
Notes
399399
-----
@@ -650,7 +650,8 @@ def plot(self, plot_peaks=None, plot_aperiodic=True, plt_log=False,
650650

651651

652652
@copy_doc_func_to_method(save_report_fm)
653-
def save_report(self, file_name, file_path=None, plt_log=False, add_settings=True, **plot_kwargs):
653+
def save_report(self, file_name, file_path=None, plt_log=False,
654+
add_settings=True, **plot_kwargs):
654655

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

fooof/objs/group.py

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -542,7 +542,8 @@ def print_results(self, concise=False):
542542
print(gen_results_fg_str(self, concise))
543543

544544

545-
def save_model_report(self, index, file_name, file_path=None, plt_log=False, **plot_kwargs):
545+
def save_model_report(self, index, file_name, file_path=None, plt_log=False,
546+
add_settings=True, **plot_kwargs):
546547
""""Save out an individual model report for a specified model fit.
547548
548549
Parameters
@@ -555,14 +556,16 @@ def save_model_report(self, index, file_name, file_path=None, plt_log=False, **p
555556
Path to directory to save to. If None, saves to current directory.
556557
plt_log : bool, optional, default: False
557558
Whether or not to plot the frequency axis in log space.
559+
add_settings : bool, optional, default: True
560+
Whether to add a print out of the model settings to the end of the report.
558561
plot_kwargs : keyword arguments
559562
Keyword arguments to pass into the plot method.
560-
561563
"""
562-
563-
self.get_fooof(ind=index, regenerate=True).save_report(file_name, file_path, plt_log, **plot_kwargs)
564564

565-
565+
self.get_fooof(ind=index, regenerate=True).save_report(\
566+
file_name, file_path, plt_log, **plot_kwargs)
567+
568+
566569
def to_df(self, peak_org):
567570
"""Convert and extract the model results as a pandas object.
568571

0 commit comments

Comments
 (0)