Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
smathot committed Nov 3, 2022
1 parent 96af826 commit dffd46d
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 4 deletions.
Binary file modified img/signal-plot-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/signal-plot-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions readme-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ print(tst.summarize(results))
We can pass the `results` to `plot()` to visualize the results:

```python
plt.clf()
tst.plot(dm, dv='pupil', hue_factor='set_size', linestyle_factor='color_type',
results=results)
plt.savefig('img/signal-plot-2.png')
Expand Down
11 changes: 7 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ We can pass the `results` to `plot()` to visualize the results:


```python
plt.clf()
tst.plot(dm, dv='pupil', hue_factor='set_size', linestyle_factor='color_type',
results=results)
plt.savefig('img/signal-plot-2.png')
Expand Down Expand Up @@ -348,9 +349,10 @@ annotated in the figure.
The name of a regular (non-series) column in `dm` that specifies the
linestyle of the lines for a two-factor plot.

* **hues: list or None, optional**
* **hues: str, list, or None, optional**

A list of hues to be used as line colors for the first factor.
The name of a matplotlib colormap or a list of hues to be used as line
colors for the hue factor.

* **linestyles: list or None, optional**

Expand All @@ -366,9 +368,10 @@ annotated in the figure.
Specifies whether the intercept should also be annotated along with
the fixed effects.

* **annotation\_hues: list or None, optional**
* **annotation\_hues: str, list, or None, optional**

A list of hues to be used as line color for the annotations.
The name of a matplotlib colormap or a list of hues to be used for the
annotations if `results` is provided.

* **annotation\_linestyle: str, optional**

Expand Down

0 comments on commit dffd46d

Please sign in to comment.