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 3f6ab97 commit 0907c30
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 0 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.
29 changes: 29 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,35 @@ parameters.
A dict where keys are effect labels, and values are named tuples
of `model`, `samples`, `p`, and `z`.

## <span style="color:purple">time\_series\_test.lmer\_series</span>_(dm, formula, winlen=1, fit\_kwargs={}, \*\*kwargs)_

Performs a sample-by-sample linear-mixed-effects analysis.

### Parameters

* **dm: DataMatrix**

* **formula: str**

* **winlen: int, optional**

* **fit\_kwargs: dict, optional**

* **\*\*kwargs: dict, optional**

### Returns

* **_DataMatrix_**

A DataMatrix with one row per effect, including the intercept, and
three series columns with the same depth as the dependent measure
specified in the formula:

- `est`: the slope
- `p`: the p value
- `z`: the z value
- `se`: the standard error

## <span style="color:purple">time\_series\_test.plot</span>_(dm, dv, hue\_factor, results=None, linestyle\_factor=None, hues=None, linestyles=None, alpha\_level=0.05, annotate\_intercept=False, annotation\_hues=None, annotation\_linestyle=':')_

Visualizes a time series, where the signal is plotted as a function of
Expand Down

0 comments on commit 0907c30

Please sign in to comment.