Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: update plot_butterfly docs #119

Merged
merged 3 commits into from
Nov 28, 2023
+12 −6
Merged

Docs: update plot_butterfly docs #119

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bece59e
Update plot_erp.jl
behinger Nov 22, 2023
cb119ea
better docs
behinger Nov 26, 2023
a49acef
Update plot_erp.jl
vladdez Nov 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions src/plot_erp.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,14 @@ Plot an ERP plot.

- `categorical_color` (bool, `true`): in case of numeric `:color` column, treat `:color` as continuous or categorical variable.
- `categorical_group` (bool, `true`): in case of numeric `:group` column, treat `:group` as categorical variable by default.
- `topolegend` (bool, `false`): add an inlay topoplot with corresponding electrodes.
- `stderror` (bool, `false`): add an error ribbon, with lower and upper limits based on the `:stderror` column.
- `pvalue` (Array, `[]`): show a pvalue.
- example: `DataFrame(from=[0.1, 0.3], to=[0.5, 0.7], coefname=["(Intercept)", "condition:face"])` - if coefname is not specified, the lines will be black
- example: `DataFrame(from=[0.1, 0.3], to=[0.5, 0.7], coefname=["(Intercept)", "condition:face"])` - if coefname is not specified, the lines will be black.
- `positions` (Array, `[]`): see plot_butterfly.
- `topolegend` (bool, `false`): (see `plot_butterfly`).

Internal-use only:
- `butterfly` (bool, `true`): a butterfly plot instead of an ERP-plot. See `plot_butterfly`

$(_docstring(:erp))

Expand All @@ -34,15 +37,18 @@ plot_erp(plot_data::DataFrame; kwargs...) = plot_erp!(Figure(), plot_data, ; kwa

"""
Plot a butterfly plot
plot_butterfly(plot_data::DataFrame; positions=nothing) =

## kwargs (...; ...):

- `butterfly` (bool, `true`): create a butterfly plot.
- `topolegend` (bool, `true`): show an inlay topoplot with corresponding electrodes.
- `positions` (Array, `[]`): if specified, adds a topoplot as an inset legend to the provided channel positions. Must be the same length as `plot_data`.
To change the colors of the channel lines use the `topoposition_to_color` function.
- `topolegend` (bool, `true`): show an inlay topoplot with corresponding electrodes. Requires `positions` to be provided.
- `topomarkersize` (Real, `10`): change the size of the markers, topoplot-inlay electrodes.
- `topowidth` (Real, `0.25`): change the size of the inlay topoplot width.
- `topoheigth` (Real, `0.25`): change the size of the inlay topoplot height.
- `topopositions_to_color` (function, ´x -> posToColorRomaO(x)´).
- `topopositions_to_color` (function, ´x -> posToColorRomaO(x)´): change the colors of the channel lines.



$(_docstring(:butterfly))
see also [`plot_erp`](@Ref)
Expand Down
Loading