readme updates

schmidtfa · Aug 9, 2024 · f017f89 · f017f89
1 parent 061ff1e
commit f017f89
Show file tree

Hide file tree

Showing 5 changed files with 148 additions and 98 deletions.
diff --git a/README.md b/README.md
@@ -61,22 +61,43 @@ irasa_out = irasa(sig,
 
 ```
 
+![image info](./simulations/example_knee.png)
+
 Extract periodic parameters
 
 ```python
 
 irasa_out.get_peaks()
 
 ```
+|   ch_name |   cf |      bw |     pw |
+|----------:|-----:|--------:|-------:|
+|         0 |  9.5 | 1.44337 | 0.4146 |
 
 Extract aperiodic parameters
 
 ```python
 
-irasa_out.fit_aperiodic_model(fit_func='knee')
+irasa_out.fit_aperiodic_model(fit_func='knee').aperiodic_params
 
 ```
 
+|   Offset |   Knee |   Exponent_1 |   Exponent_2 | fit_type   |   Knee Frequency (Hz) |   ch_name |
+|---------:|-------:|-------------:|-------------:|:-----------|----------------------:|----------:|
+|  1.38098 | 532.91 |     0.511999 |      1.89448 | knee       |               8.59554 |         0 |
+
+And the goodness of fit
+
+```python
+
+irasa_out.fit_aperiodic_model(fit_func='knee').gof
+
+```
+
+|         mse |   r_squared |      BIC |      AIC | fit_type   |   ch_name |
+|------------:|------------:|---------:|---------:|:-----------|----------:|
+| 3.02402e-05 |    0.999894 | -2049.69 | -2062.86 | knee       |         0 |
+
 
 ### How to Contribute
 

diff --git a/examples/basic_functionality.ipynb b/examples/basic_functionality.ipynb
diff --git a/pixi.lock b/pixi.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -64,6 +64,7 @@ neurodsp = ">=2.2.0,<2.3"
 mne = ">=1.7.0,<1.8"
 mypy = ">=1.10.1,<2"
 pandas-stubs = ">=2.2.2.240603,<3"
+tabulate = ">=0.9.0,<0.10"
 
 [tool.pixi.feature]
 py311 = {dependencies = {python="3.11.*"}}

diff --git a/simulations/example_knee.png b/simulations/example_knee.png