|
1 | 1 | """ |
2 | | -Reporting & Referencing |
3 | | -======================= |
| 2 | +09: Reporting & Referencing |
| 3 | +=========================== |
4 | 4 |
|
5 | | -This example covers utilities for getting reporting information and referencing use of the module. |
| 5 | +This section covers how to access reporting info and reference use of the module. |
6 | 6 |
|
7 | 7 | This page is a hands-on example of the reporting and referencing information on the |
8 | 8 | `Reference page <https://fooof-tools.github.io/fooof/reference.html>`_. |
|
19 | 19 | # Import utilities to print out information for reporting |
20 | 20 | from fooof.utils.reports import methods_report_info, methods_report_text |
21 | 21 |
|
| 22 | +# sphinx_gallery_start_ignore |
| 23 | +# Note: this code gets hidden, but serves to create the text plot for the icon |
| 24 | +from fooof.core.strings import gen_methods_report_str |
| 25 | +from fooof.core.reports import REPORT_FONT |
| 26 | +import matplotlib.pyplot as plt |
| 27 | +text = gen_methods_report_str(concise=True) |
| 28 | +text = text[0:142] + '\n' + text[142:] |
| 29 | +_, ax = plt.subplots(figsize=(8, 3)) |
| 30 | +ax.text(0.5, 0.5, text, REPORT_FONT, ha='center', va='center') |
| 31 | +ax.set_frame_on(False) |
| 32 | +_ = ax.set(xticks=[], yticks=[]) |
| 33 | +# sphinx_gallery_end_ignore |
| 34 | + |
22 | 35 | ################################################################################################### |
23 | 36 | # Checking Module Version |
24 | 37 | # ----------------------- |
|
0 commit comments