Skip to content

Commit

Permalink
Update plot_erp.jl (#76)
Browse files Browse the repository at this point in the history
* Update plot_erp.jl

* new tests, combined plot in docs

* del

* additional docs problems

* little detail

* dead links

* docstring warnings

* cross-refs again

* test

* pp_plot fixed

* docs errors should be resolved

* Update hide_deco.md
  • Loading branch information
vladdez authored Sep 21, 2023
1 parent 038b895 commit 31ed81d
Show file tree
Hide file tree
Showing 32 changed files with 249 additions and 927 deletions.
23 changes: 10 additions & 13 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -12,38 +12,35 @@ using Literate
using Glob

GENERATED = joinpath(@__DIR__, "src", "literate")
for subfolder ["explanations","HowTo","tutorials","reference"]
local SOURCE_FILES = Glob.glob(subfolder*"/*.jl", GENERATED)
foreach(fn -> Literate.markdown(fn, GENERATED*"/"*subfolder), SOURCE_FILES)
for subfolder ["explanations", "HowTo", "tutorials", "reference"]
local SOURCE_FILES = Glob.glob(subfolder * "/*.jl", GENERATED)
foreach(fn -> Literate.markdown(fn, GENERATED * "/" * subfolder), SOURCE_FILES)

end




DocMeta.setdocmeta!(UnfoldMakie, :DocTestSetup, :(using UnfoldMakie); recursive=true)

makedocs(;
modules=[UnfoldMakie],
authors="Benedikt Ehinger, Daniel Baumgartner, Niklas Gärtner, Sören Döring",
authors="Benedikt Ehinger, Vladimir Mikheev, Daniel Baumgartner, Niklas Gärtner, Sören Döring",
repo="https://github.com/unfoldtoolbox/UnfoldMakie.jl/blob/{commit}{path}#{line}",
sitename="UnfoldMakie.jl",
format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true",
canonical="https://unfoldtoolbox.github.io/UnfoldMakie.jl",
assets=String[],
assets=String[]
),
pages=[
"UnfoldMakie Documentation" => "index.md",
"Visualizations-Types" => [
"ERP plot" => "literate/tutorials/erp.md",
"ERP plot" => "literate/tutorials/erp.md",
"Butterfly Plot" => "tutorials/butterfly.md",
"Designmatrix" => "tutorials/designmatrix.md",
"ERP Image" => "tutorials/erpimage.md",
"Parallel Coordinates Plot" => "tutorials/parallelcoordinates.md",
"Topo Plot" => "tutorials/topoplot.md",
"Topo Plot Series" => "tutorials/topoplotseries.md",
"Circular TopoPlot" => "literate/tutorials/circTopo.md",
"Circular TopoPlot" => "literate/tutorials/circTopo.md",
],
"Plot Configuration" => [
"Axis Data" => "config/axis_data.md",
Expand All @@ -61,13 +58,13 @@ makedocs(;
"Include multiple Visualizations in one Figure" => "how_to/mult_vis_in_fig.md",
"Show out of Bounds Label" => "how_to/show_oob_labels.md",
],
"Reference" => [
"Reference" => [
"Convert 3D positions / montages to 2D layouts" => "literate/reference/positions.md"
]
],
]
)

deploydocs(;
repo="github.com/unfoldtoolbox/UnfoldMakie.jl",
devbranch="main",
devbranch="main"
)
272 changes: 0 additions & 272 deletions docs/nb_testAll.jl

This file was deleted.

2 changes: 1 addition & 1 deletion docs/src/config/colorbar_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Furthermore `extra=(;categoricalColor=false)` needs to be `false`.
## Other Plots
In all other Plots the `Colorbar` function of the `Makie` module is used ([documentation](https://makie.juliaplots.org/v0.17.13/examples/blocks/colorbar/index.html)).

The Colorbar will only be used when both `layoutData.showLegend` and `layoutData.useColorbar` are set `true`.
The Colorbar will only be used when both `layoutData.showLegend` and `layoutData.useColorbar` are set to `true`.

## Colorbar data default values

Expand Down
4 changes: 2 additions & 2 deletions docs/src/config/extra_data.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# [Extra Data](@id config_extra)

The extra data of the configuration consists of all config options that are unique for the visualizations.
The configuration extra data consists of all configuration options that are unique to the visualizations.

The available options for each plot are described at the end of their respective tutorial in the `Tutorials: Visualizations` section.
The options available for each plot are described at the end of each tutorial in the `Tutorials: Visualizations` section.
4 changes: 2 additions & 2 deletions docs/src/config/layout_data.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# [Layout Data](@id config_layout)

The layout data of the configuration consists of config options for the layout such as the legend and labels.
The layout data of the configuration consists of configuration options for the layout, such as the legend and labels.

The following layout data options exist (the default values may be different for some plots types):
The following layout data options are available (defaults may be different for some plot types):

## showLegend (boolean)
Indicating whether the legend is displayed.
Expand Down
4 changes: 2 additions & 2 deletions docs/src/config/legend_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ The legend data of the configuration consists of config options for the legend.
## Line Plots and Butterfly Plots
For line plots the `legend!` function of the `AlgebraOfGraphics` module is used ([documentation](http://juliaplots.org/AlgebraOfGraphics.jl/stable/API/functions/#AlgebraOfGraphics.legend!)).

The `Legend` will be used automatically, when `AlgebraOfGraphics` is able to draw it.
The `Legend` is used automatically, if `AlgebraOfGraphics` is able to draw it.
For this the `color` data will be used and has to be either non-numerical or `funcall(...;extra=(categoricalColor=true,)` needs to be set `true`.

## Parallel Coordinates Plots
In a parallel coordinate plot the `Legend` function of the `Makie` module is used ([documentation](https://makie.juliaplots.org/v0.17.13/examples/blocks/legend/index.html)).

The Legend will only be used when `funcall(...;layout=(showLegend=true,)` is `true` and `funcall(...;layout=(useColorbar=false,)` is `false`
The legend is only used if `funcall(...;layout=(showLegend=true,)` is `true` and `funcall(...;layout=(useColorbar=false,)` is `false`

## Legend data default options

Expand Down
Loading

0 comments on commit 31ed81d

Please sign in to comment.