Skip to content

Commit

Permalink
fixes from review
Browse files Browse the repository at this point in the history
  • Loading branch information
TomDonoghue committed Jul 20, 2023
1 parent 0b6760c commit c43942c
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion doc/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ In addition, we recommend that reports should include information on:
Reporting Template & Example
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To assist in reporting on using FOOOF, we have created some templates for reporting on spectral parameterization methods. There are also some utilities included in the code to collected the required information.
To assist in reporting on using FOOOF, we have created some templates for reporting on spectral parameterization methods. There are also some utilities included in the code to collect the required information.

The following box is an example of what a methods report might look like (where all of the *X*'s should be filled in with the relevant information).

Expand Down
8 changes: 4 additions & 4 deletions examples/models/plot_aperiodic_params.py
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
#
# This can also be seen in this animation showing this effect across different rotation points:
#
# ![spectralrotation](https://raw.githubusercontent.com/fooof-tools/Visualizers/main/gifs/specrot.gif "specrot")
# .. image:: https://raw.githubusercontent.com/fooof-tools/Visualizers/main/gifs/specrot.gif
#
# Notably this means that while the offset and exponent can change independently (there can be
# offset changes over and above exponent changes), the baseline expectation is that these
Expand Down Expand Up @@ -144,13 +144,13 @@
# Knee Frequency
# ~~~~~~~~~~~~~~
#
# You might notice that the knee _parameter_ is not an obvious value. Notably, this parameter
# You might notice that the knee *parameter* is not an obvious value. Notably, this parameter
# value as extracted from the model is something of an abstract quantify based on the
# formalization of the underlying fit function. A more intuitive measure that we may
# be interested in is the 'knee frequency', which is an estimate of the frequency value
# at which the knee occurs.
#
# The `:func:`~.compute_knee_frequency` function can be used to compute the knee frequency.
# The :func:`~.compute_knee_frequency` function can be used to compute the knee frequency.
#

###################################################################################################
Expand All @@ -166,7 +166,7 @@
# Another interesting property of the knee parameter is that it has a direct relationship
# to the auto-correlation function, and from there to the empirical time constant of the data.
#
# The `:func:`~.compute_time_constant` function can be used to compute the knee-derived
# The :func:`~.compute_time_constant` function can be used to compute the knee-derived
# time constant.
#

Expand Down
1 change: 1 addition & 0 deletions tutorials/plot_09-Reporting.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
# -----------------------------------
#
# To assist with reporting information, the module has the following utilities:
#
# - the :func:`~.methods_report_info`, which prints out methods reporting information
# - the :func:`~.methods_report_text`, which prints out a template of methods reporting text
#
Expand Down

0 comments on commit c43942c

Please sign in to comment.