Repository navigation
Expand file tree
/
Copy pathreports.py
More file actions
46 lines (35 loc) · 1.64 KB
/
Copy pathreports.py
File metadata and controls
46 lines (35 loc) · 1.64 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
"""Utilities to create reports and useful print outs."""
from fooof.core.strings import (gen_version_str, gen_settings_str, gen_freq_range_str,
gen_methods_report_str, gen_methods_text_str)
###################################################################################################
###################################################################################################
def methods_report_info(fooof_obj=None, concise=False):
"""Prints out a report of information required for methods reporting.
Parameters
----------
fooof_obj : FOOOF or FOOOFGroup, optional
An object with setting information available.
If provided, is used to collect and print information to be reported.
concise : bool, optional, default: False
Whether to print the report in concise mode.
Notes
-----
Any missing values (information that is not available) will be printed out as 'XX'.
"""
print(gen_methods_report_str(concise))
if fooof_obj:
print(gen_version_str(concise))
print(gen_settings_str(fooof_obj, concise=concise))
print(gen_freq_range_str(fooof_obj, concise=concise))
def methods_report_text(fooof_obj=None):
"""Prints out a text template of methods reporting information.
Parameters
----------
fooof_obj : FOOOF or FOOOFGroup, optional
An object with setting information available.
If None, the text is returned as a template, without values.
Notes
-----
Any missing values (information that is not available) will be printed out as 'XX'.
"""
print(gen_methods_text_str(fooof_obj))