From ab9715fd1cd35dbab98de1bbda6a9f04a28345c2 Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Mon, 11 Sep 2023 18:01:56 +0000 Subject: [PATCH] build based on af04ea8 --- dev/config/axis_data/index.html | 2 +- dev/config/colorbar_data/index.html | 2 +- dev/config/extra_data/index.html | 2 +- dev/config/layout_data/index.html | 2 +- dev/config/legend_data/index.html | 2 +- dev/config/mapping_data/index.html | 2 +- dev/config/visual_data/index.html | 2 +- dev/how_to/fix_pcp/index.html | 2 +- dev/how_to/hide_deco/index.html | 2 +- dev/how_to/mult_vis_in_fig/index.html | 2 +- dev/how_to/position2color/index.html | 2 +- dev/how_to/show_oob_labels/index.html | 2 +- dev/index.html | 2 +- dev/literate/tutorials/circTopo/index.html | 2 +- dev/literate/tutorials/erp/index.html | 2 +- dev/search/index.html | 2 +- dev/tutorials/butterfly/index.html | 2 +- dev/tutorials/designmatrix/index.html | 2 +- dev/tutorials/erpimage/index.html | 2 +- dev/tutorials/installation/index.html | 2 +- dev/tutorials/parallelcoordinates/index.html | 2 +- dev/tutorials/topoplot/index.html | 2 +- dev/tutorials/topoplotseries/index.html | 2 +- 23 files changed, 23 insertions(+), 23 deletions(-) diff --git a/dev/config/axis_data/index.html b/dev/config/axis_data/index.html index b08f04cbf..af7dbca7d 100644 --- a/dev/config/axis_data/index.html +++ b/dev/config/axis_data/index.html @@ -1,2 +1,2 @@ -Axis Data · UnfoldMakie.jl
Edit on GitHub

Axis Data

The axis data of the configuration consists of config options for the axis.

The input of this config is directly fed into the Axis function of the Makie module. As a consequence, the possible options are also determined by the function. Details for these options can be found in the corresponding article of the Makie documentation.

+Axis Data · UnfoldMakie.jl
Edit on GitHub

Axis Data

The axis data of the configuration consists of config options for the axis.

The input of this config is directly fed into the Axis function of the Makie module. As a consequence, the possible options are also determined by the function. Details for these options can be found in the corresponding article of the Makie documentation.

diff --git a/dev/config/colorbar_data/index.html b/dev/config/colorbar_data/index.html index ced532d7f..c6d59fe5e 100644 --- a/dev/config/colorbar_data/index.html +++ b/dev/config/colorbar_data/index.html @@ -1,2 +1,2 @@ -Colorbar Data · UnfoldMakie.jl
Edit on GitHub

Colorbar Data

The colorbar data of the configuration consists of config options for the colorbar that can be used as a legend. As a consequence, the possible options are determined by the underlying functions.

ERP Plots

For ERP plots, the colorbar! function of the AlgebraOfGraphics module is used (documentation).

The Colorbar will be automatically used, when AlgebraOfGraphics is able to draw it. For this, the color data will be used and has to be numerical. Furthermore extra=(;categoricalColor=false) needs to be false.

Other Plots

In all other Plots the Colorbar function of the Makie module is used (documentation).

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

Colorbar data default values

  • vertical = true
  • tellwidth = true
  • tellheight = true
+Colorbar Data · UnfoldMakie.jl
Edit on GitHub

Colorbar Data

The colorbar data of the configuration consists of config options for the colorbar that can be used as a legend. As a consequence, the possible options are determined by the underlying functions.

ERP Plots

For ERP plots, the colorbar! function of the AlgebraOfGraphics module is used (documentation).

The Colorbar will be automatically used, when AlgebraOfGraphics is able to draw it. For this, the color data will be used and has to be numerical. Furthermore extra=(;categoricalColor=false) needs to be false.

Other Plots

In all other Plots the Colorbar function of the Makie module is used (documentation).

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

Colorbar data default values

  • vertical = true
  • tellwidth = true
  • tellheight = true
diff --git a/dev/config/extra_data/index.html b/dev/config/extra_data/index.html index daa756c50..d7ca8eb35 100644 --- a/dev/config/extra_data/index.html +++ b/dev/config/extra_data/index.html @@ -1,2 +1,2 @@ -Extra Data · UnfoldMakie.jl
Edit on GitHub

Extra Data

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

The available options for each plot are described at the end of their respective tutorial in the Tutorials: Visualizations section.

+Extra Data · UnfoldMakie.jl
Edit on GitHub

Extra Data

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

The available options for each plot are described at the end of their respective tutorial in the Tutorials: Visualizations section.

diff --git a/dev/config/layout_data/index.html b/dev/config/layout_data/index.html index fbcd33a21..d68c7a1bd 100644 --- a/dev/config/layout_data/index.html +++ b/dev/config/layout_data/index.html @@ -3,4 +3,4 @@ ... hidespines = (:r, :t), hidedecorations = () -)

Setting them to nothing will disable them. More information on how to use them can be found in this HowTo

+)

Setting them to nothing will disable them. More information on how to use them can be found in this HowTo

diff --git a/dev/config/legend_data/index.html b/dev/config/legend_data/index.html index dd6e9007d..1533fab71 100644 --- a/dev/config/legend_data/index.html +++ b/dev/config/legend_data/index.html @@ -1,2 +1,2 @@ -Legend Data · UnfoldMakie.jl
Edit on GitHub

Legend Data

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).

The Legend will be used automatically, when 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).

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

Legend data default options

  • orientation = :vertical
  • tellwidth = true
  • tellheight = true
+Legend Data · UnfoldMakie.jl
Edit on GitHub

Legend Data

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).

The Legend will be used automatically, when 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).

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

Legend data default options

  • orientation = :vertical
  • tellwidth = true
  • tellheight = true
diff --git a/dev/config/mapping_data/index.html b/dev/config/mapping_data/index.html index c4eb00e68..2e13c3e03 100644 --- a/dev/config/mapping_data/index.html +++ b/dev/config/mapping_data/index.html @@ -1,3 +1,3 @@ Mapping Data · UnfoldMakie.jl
Edit on GitHub

Mapping Data

The mapping data of the configuration is used to let the plotting functions know which columns of a DataFrame contain which data. Therefore it is only used in plots with a DataFrame as input.

For example a Line Plot makes use of the x and y mappings. To have our Line Plot use the "estimate" column for x and the "time" column for y we can use:

plot_erp(...;mapping=(;x=:estimate,))
-

Which columns are used by which plotting function can be looked up in their respective tutorials in the Tutorials: Visualizations section.

Multiple Options

In addition to providing a single column which contains the specified data, the user can also provide a list of columns which may contain the data.

plot_erp(...;mapping=(;y = (:y, :yhat, :estimate)))

In this case the first available column will be chosen.

Some configurations for certain plots already have a default column or a list of columns set. This way the user might not need to set any mapping values themselves, in case the DataFrame conforms to the same standards.

+

Which columns are used by which plotting function can be looked up in their respective tutorials in the Tutorials: Visualizations section.

Multiple Options

In addition to providing a single column which contains the specified data, the user can also provide a list of columns which may contain the data.

plot_erp(...;mapping=(;y = (:y, :yhat, :estimate)))

In this case the first available column will be chosen.

Some configurations for certain plots already have a default column or a list of columns set. This way the user might not need to set any mapping values themselves, in case the DataFrame conforms to the same standards.

diff --git a/dev/config/visual_data/index.html b/dev/config/visual_data/index.html index aea2626eb..ca2e7b058 100644 --- a/dev/config/visual_data/index.html +++ b/dev/config/visual_data/index.html @@ -1,2 +1,2 @@ -Visual Data · UnfoldMakie.jl
Edit on GitHub

Visual Data

The visual data of the configuration will be passed to the underlying plotting functions and can be used to set their specific attributes.

As a consequence, the possible options are determined by the following functions:

+Visual Data · UnfoldMakie.jl
Edit on GitHub

Visual Data

The visual data of the configuration will be passed to the underlying plotting functions and can be used to set their specific attributes.

As a consequence, the possible options are determined by the following functions:

diff --git a/dev/how_to/fix_pcp/index.html b/dev/how_to/fix_pcp/index.html index da49ef34e..77348a582 100644 --- a/dev/how_to/fix_pcp/index.html +++ b/dev/how_to/fix_pcp/index.html @@ -10,4 +10,4 @@ pc_bottom_padding = 27, ...

Furthermore, if the tick-number size becomes too big or small it can be changed with:

...
 pc_tick_label_size = 25,
-...

By setting these manually through trial and error we can fix the visualization issues:

Fixed PCP

+...

By setting these manually through trial and error we can fix the visualization issues:

Fixed PCP

diff --git a/dev/how_to/hide_deco/index.html b/dev/how_to/hide_deco/index.html index e7bb7c1f7..3f8c62521 100644 --- a/dev/how_to/hide_deco/index.html +++ b/dev/how_to/hide_deco/index.html @@ -6,4 +6,4 @@ )

Since these values mirror the input of the function, we can use an empty tuple to remove all decorations or spines respectively

And using hidespines = (:r, :t) results in the removal of the top and right border.

For more information on the input of these functions refer to the Makie dokumentation on Axis.

Since some plots hide features by default, the hiding can be reverted by setting the variables to nothing

plot_xxx(...;layout=(;
     hidespines = nothing,
     hidedecorations = nothing
-)

Topoplot with all axis spines and decorations enabled

+)

Topoplot with all axis spines and decorations enabled

diff --git a/dev/how_to/mult_vis_in_fig/index.html b/dev/how_to/mult_vis_in_fig/index.html index 9255b2c76..4c25bbda2 100644 --- a/dev/how_to/mult_vis_in_fig/index.html +++ b/dev/how_to/mult_vis_in_fig/index.html @@ -61,4 +61,4 @@ plot_circulareegtopoplot!(f[3:4, 4:5], d_topo[in.(d_topo.time, Ref(-0.3:0.1:0.5)), :]; positions=positions, predictor=:time, extra=(; predictorBounds=[-0.3, 0.5])) -f +f diff --git a/dev/how_to/position2color/index.html b/dev/how_to/position2color/index.html index c4ab0cf36..77858d59e 100644 --- a/dev/how_to/position2color/index.html +++ b/dev/how_to/position2color/index.html @@ -4,4 +4,4 @@ using DataFramesMeta

By default the plot looks like this:

include("../../example_data.jl")
 results,positions = example_data("TopoPlots.jl")
 plot_butterfly(results;positions=positions)

We can switch the colorscale of the position-map, by giving a function that maps from a (x,y) tuple to a color. UnfoldMakie currently provides three different ones pos2colorRGB (same as MNE-Python), pos2colorHSV (HSV colorspace), pos2colorRomaO. Whereas RGB & HSV have the benefits of being 2D colormaps, Roma0 has the benefit of being perceptualy uniform.

Similar to MNE

plot_butterfly(results;positions=positions,extra=(;topoPositionToColorFunction=pos->UnfoldMakie.posToColorRGB(pos)))

HSV-Space

plot_butterfly(results;positions=positions,extra=(;topoPositionToColorFunction=UnfoldMakie.posToColorHSV))

Uniform Color

To highlight the flexibility, we can also make all lines gray, or any other arbitrary color, or function of electrode-position.

using Colors
-plot_butterfly(results;positions=positions,extra=(;topoPositionToColorFunction=x->Colors.RGB(0.5)))
+plot_butterfly(results;positions=positions,extra=(;topoPositionToColorFunction=x->Colors.RGB(0.5))) diff --git a/dev/how_to/show_oob_labels/index.html b/dev/how_to/show_oob_labels/index.html index 0212178b1..bd00d7d60 100644 --- a/dev/how_to/show_oob_labels/index.html +++ b/dev/how_to/show_oob_labels/index.html @@ -2,4 +2,4 @@ Show out of Bounds Label · UnfoldMakie.jl
Edit on GitHub

Show out of Bounds Label

When visualizing a designmatrix it can happen that the labels on the y-axis get cut off towards the left (especially if they are quite long). In the following we discuss a possible quick fix for this problem.

Here we start off with the "label-limited" timeexpanded designmatrix from the corresponding How To section that details how it can be generated.

plot_designmatrix(designmatrix!(ufCont,evts),cDesign;setExtraValues=(xTicks=10, sortData=false))

#Label Limited Timeexpanded Designmatrix

While the plot automatically sets it's height accoring to the labels, they are cut off on the left side.

A quick fix would be to place an empty plot to the left of the designmatrix.

By creating your own figure with Makie.Figure, and then only giving a certain grid position to the designmatrix we get white space next to the plot.

The plot! function inside the plot config instance can take any grid position, and the figure f will include plot and sufficient white space next to it.

The exact numbers in the grid position can be guessed from the ratio of the overlap, or just tried out.

f = Figure()
 plot_design(f[1,2:6],designmatrix!(ufCont,evts),cDesign;setExtraValues=(xTicks=10, sortData=false))
 
-f

#Label Limited Timeexpanded Designmatrix

+f

#Label Limited Timeexpanded Designmatrix

diff --git a/dev/index.html b/dev/index.html index 80c41102c..c494d57ea 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,2 +1,2 @@ -UnfoldMakie Documentation · UnfoldMakie.jl
Edit on GitHub

UnfoldMakie Documentation

This is the documentation of the UnfoldMakie module for the Julia programming language.

About

UnfoldMakie aims to allow users to generate different types of visualizations. These include line plots, butterfly plots, designmatrices, parallel coordinates plots, ERP images and topo plots. Building on the Unfold and Makie Modules, it also grants users customizability through an input configuration on the plots.

As is apparent considering the types of possible visualizations, these config options try to enable users to create plots, that are helpful in the subject area of computational EEG. One such example is the possibility of using a topo plot as a legend for a line plot by allowing for multiple visualizations within one figure.

Coordinated Multiple Views

Structure

For easy readability, the documentation is divided into sections users can inspect depending on their query.

The Tutorials: Setup section contains all information to get started including installation and how to aquire necessary data for testing if the user has none.

The Tutorials: Visualizations section summarizes all possible visualizations and how users can generate them. It also details their unique configuration options.

These visualizations are:

The Plot Configuration all segments of the config, detailing their contained attributes. The plot config is the prime interface allowing the user to access the different visualition options. As the options can be quite different in nature, the plot config is further split into categories. These segments are:

The How To section features information on how to achieve specific goals or deal with specific problems.

These segments are:

Used Packages

Everything was tested with Julia v1.7.

The following module in their respective versions are used internally by UnfoldMakie:

  • AlgebraOfGraphics v0.6.9
  • CairoMakie v0.8.9
  • Colors v0.12.8
  • ColorSchemes v3.19.0
  • DataFrames v1.3.4
  • GeometryBasics v0.4.2
  • ImageFiltering v0.7.1
  • Makie v0.17.9
  • Pipe v1.3.0
  • PyMNE v0.1.2
  • TopoPlots v0.1.0
  • Unfold v0.3.11
  • LinearAlgebra
  • SparseArrays
  • Statistics
+UnfoldMakie Documentation · UnfoldMakie.jl
Edit on GitHub

UnfoldMakie Documentation

This is the documentation of the UnfoldMakie module for the Julia programming language.

About

UnfoldMakie aims to allow users to generate different types of visualizations. These include line plots, butterfly plots, designmatrices, parallel coordinates plots, ERP images and topo plots. Building on the Unfold and Makie Modules, it also grants users customizability through an input configuration on the plots.

As is apparent considering the types of possible visualizations, these config options try to enable users to create plots, that are helpful in the subject area of computational EEG. One such example is the possibility of using a topo plot as a legend for a line plot by allowing for multiple visualizations within one figure.

Coordinated Multiple Views

Structure

For easy readability, the documentation is divided into sections users can inspect depending on their query.

The Tutorials: Setup section contains all information to get started including installation and how to aquire necessary data for testing if the user has none.

The Tutorials: Visualizations section summarizes all possible visualizations and how users can generate them. It also details their unique configuration options.

These visualizations are:

The Plot Configuration all segments of the config, detailing their contained attributes. The plot config is the prime interface allowing the user to access the different visualition options. As the options can be quite different in nature, the plot config is further split into categories. These segments are:

The How To section features information on how to achieve specific goals or deal with specific problems.

These segments are:

Used Packages

Everything was tested with Julia v1.7.

The following module in their respective versions are used internally by UnfoldMakie:

  • AlgebraOfGraphics v0.6.9
  • CairoMakie v0.8.9
  • Colors v0.12.8
  • ColorSchemes v3.19.0
  • DataFrames v1.3.4
  • GeometryBasics v0.4.2
  • ImageFiltering v0.7.1
  • Makie v0.17.9
  • Pipe v1.3.0
  • PyMNE v0.1.2
  • TopoPlots v0.1.0
  • Unfold v0.3.11
  • LinearAlgebra
  • SparseArrays
  • Statistics
diff --git a/dev/literate/tutorials/circTopo/index.html b/dev/literate/tutorials/circTopo/index.html index 07cb8100e..521b8ada0 100644 --- a/dev/literate/tutorials/circTopo/index.html +++ b/dev/literate/tutorials/circTopo/index.html @@ -9,4 +9,4 @@ :estimate=>eachcol(Float64.(data[:,100:40:300,1])), :circularVariable=>[0,50,80,120,180,210], :time=>100:40:300) -df = flatten(df,:estimate);

Our first plot!

note how the plots are at the angles of circularVariable`

plot_circulareegtopoplot(df;positions=pos,axis=(;label="Sac Incoming"),predictor=:circularVariable)

In case the bounding variable is not between 0 and 360, as here we use actually time, we have to specify it. e.g.

plot_circulareegtopoplot(df;positions=pos,axis=(;label="Time?!"),predictor=:time,extra=(;predictorBounds=[80,320]))

This page was generated using Literate.jl.

+df = flatten(df,:estimate);

Our first plot!

note how the plots are at the angles of circularVariable`

plot_circulareegtopoplot(df;positions=pos,axis=(;label="Sac Incoming"),predictor=:circularVariable)

In case the bounding variable is not between 0 and 360, as here we use actually time, we have to specify it. e.g.

plot_circulareegtopoplot(df;positions=pos,axis=(;label="Time?!"),predictor=:time,extra=(;predictorBounds=[80,320]))

This page was generated using Literate.jl.

diff --git a/dev/literate/tutorials/erp/index.html b/dev/literate/tutorials/erp/index.html index 5d89da425..cb60e946c 100644 --- a/dev/literate/tutorials/erp/index.html +++ b/dev/literate/tutorials/erp/index.html @@ -24,4 +24,4 @@ # coefname=["(Intercept)","condition: face"] # if coefname not specified, line should be black # )

plot_erp(results;extra= (;:pvalue=>pvals))

stderror (boolean)

Indicating whether the plot should show a colored band showing lower and higher estimates based on the stderror. Default is false.

previously we showed :stderror- but low/high is possible as well`

results.se_low = results.estimate .- 0.5
 results.se_high = results.estimate .+ 0.15
-plot_erp(select(results,Not(:stderror));extra= (;stderror=true))
Note

as in the above code,:stderror has precedence over :se_low/:se_high

This page was generated using Literate.jl.

+plot_erp(select(results,Not(:stderror));extra= (;stderror=true))
Note

as in the above code,:stderror has precedence over :se_low/:se_high

This page was generated using Literate.jl.

diff --git a/dev/search/index.html b/dev/search/index.html index 13c91fa28..598d359be 100644 --- a/dev/search/index.html +++ b/dev/search/index.html @@ -1,2 +1,2 @@ -Search · UnfoldMakie.jl

Loading search...

    +Search · UnfoldMakie.jl

    Loading search...

      diff --git a/dev/tutorials/butterfly/index.html b/dev/tutorials/butterfly/index.html index ffee299f9..1c7918d98 100644 --- a/dev/tutorials/butterfly/index.html +++ b/dev/tutorials/butterfly/index.html @@ -4,4 +4,4 @@ using CairoMakie using DataFrames

      Note that DataFramesMeta is also used here in order to be able to use @subset for testing (filtering).

      Data

      In case you want to try with different data, look at the Load Data section.

      We filter the data to make it more clearly represented:

      include("../../example_data.jl")
 df, pos = example_data("TopoPlots.jl")
-first(df,3)
      3×7 DataFrame
      RowestimatetimechannelcoefnametopoPositionssepval
      Float64Float64Int64StringAnyFloat64Float64
      10.020321-0.31A(0.493714, 0.544031)0.1228750.266091
      20.017548-0.2981A(0.493714, 0.544031)0.1243450.29664
      30.0150747-0.2961A(0.493714, 0.544031)0.1248280.323592

      Plot Butterfly Plots

      The following code will plot the default butterfly plot

      plot_butterfly(df)

      or if you provide the channel positions:

      plot_butterfly(df;positions=pos)

      Column Mappings for Butterfly Plots

      Since butterfly plots use a DataFrame as an input, the library needs to know the names of the columns used for plotting. You can set these mapping values by plot_butterfly(...; mapping=(;:x=:time,)), that is, providing a NamedTuple (note the ; just after the opening-brackets

      For more information about mapping values look into the Mapping Data section of the documentation.

      While there are multiple default values, that are checked in that order if they exist in the DataFrame, a custom name might need to be choosen for:

      x

      Default is (:x, :time).

      y

      Default is (:y, :estimate, :yhat).

      labels

      Default is (:labels, :label, :topoLabels, :sensor, :nothing)

      Configurations for Butterfly Plots

      Here we look into possible options for configuring the butterfly plot visualization using (...;extra=(<name>=<value>,...). This is the list of unique configuration (extraData):

      topoLegend (boolean)

      Indicating whether the topo legend is displayed. Default is true.

      For more general options look into the Plot Configuration section of the documentation.

      Since the configurations for line plots can be applied to butterfly plots as well. Here you can find the configurations for line plots,

      +first(df,3)
      3×7 DataFrame
      RowestimatetimechannelcoefnametopoPositionssepval
      Float64Float64Int64StringAnyFloat64Float64
      10.020321-0.31A(0.493714, 0.544031)0.1228750.266091
      20.017548-0.2981A(0.493714, 0.544031)0.1243450.29664
      30.0150747-0.2961A(0.493714, 0.544031)0.1248280.323592

      Plot Butterfly Plots

      The following code will plot the default butterfly plot

      plot_butterfly(df)

      or if you provide the channel positions:

      plot_butterfly(df;positions=pos)

      Column Mappings for Butterfly Plots

      Since butterfly plots use a DataFrame as an input, the library needs to know the names of the columns used for plotting. You can set these mapping values by plot_butterfly(...; mapping=(;:x=:time,)), that is, providing a NamedTuple (note the ; just after the opening-brackets

      For more information about mapping values look into the Mapping Data section of the documentation.

      While there are multiple default values, that are checked in that order if they exist in the DataFrame, a custom name might need to be choosen for:

      x

      Default is (:x, :time).

      y

      Default is (:y, :estimate, :yhat).

      labels

      Default is (:labels, :label, :topoLabels, :sensor, :nothing)

      Configurations for Butterfly Plots

      Here we look into possible options for configuring the butterfly plot visualization using (...;extra=(<name>=<value>,...). This is the list of unique configuration (extraData):

      topoLegend (boolean)

      Indicating whether the topo legend is displayed. Default is true.

      For more general options look into the Plot Configuration section of the documentation.

      Since the configurations for line plots can be applied to butterfly plots as well. Here you can find the configurations for line plots,

      diff --git a/dev/tutorials/designmatrix/index.html b/dev/tutorials/designmatrix/index.html index 123b1b9a5..371689207 100644 --- a/dev/tutorials/designmatrix/index.html +++ b/dev/tutorials/designmatrix/index.html @@ -16,4 +16,4 @@ coeftable(uf) (returns tidy result dataframe) -

      Plot Designmatrices

      The following code will result in the default configuration. 

      plot_designmatrix(designmatrix(uf))

      plot_designmatrix(...;extra=(<name>=<value>,...).

      In order to make the designmatrix easier to read, you may want to sort it.

      plot_designmatrix(designmatrix(uf);extra=(;sortData=true))

      Indicating the number of labels on the x-axis. Behavior if specified in configuration: - xTicks = 0: no labels are placed. - xTicks = 1: first possible label is placed. - xTicks = 2: first and last possible labels are placed. - 2 < xTicks < number of labels: xTicks-2 labels are placed between the first and last. - xTicks ≥ number of labels: all labels are placed.

      +

      Plot Designmatrices

      The following code will result in the default configuration. 

      plot_designmatrix(designmatrix(uf))

      plot_designmatrix(...;extra=(<name>=<value>,...).

      In order to make the designmatrix easier to read, you may want to sort it.

      plot_designmatrix(designmatrix(uf);extra=(;sortData=true))

      Indicating the number of labels on the x-axis. Behavior if specified in configuration: - xTicks = 0: no labels are placed. - xTicks = 1: first possible label is placed. - xTicks = 2: first and last possible labels are placed. - 2 < xTicks < number of labels: xTicks-2 labels are placed between the first and last. - xTicks ≥ number of labels: all labels are placed.

      diff --git a/dev/tutorials/erpimage/index.html b/dev/tutorials/erpimage/index.html index 9b73004aa..f7220da18 100644 --- a/dev/tutorials/erpimage/index.html +++ b/dev/tutorials/erpimage/index.html @@ -7,4 +7,4 @@ plot_erpimage(data)

      Column Mappings for ERP Images

      Since ERP images use a Matrix as an input, the library does not need any informations about the mapping.

      extra=(;)

      (sortperm() computes a permutation of the array's indices that puts the array into sorted order). 

      plot_erpimage(data;
     extra = (ploterp = true,),
     colorbar = (label = "Voltage [µV]",),
-    visual = (colormap = :viridis, colorrange = (-40, 40)))
      + visual = (colormap = :viridis, colorrange = (-40, 40))) diff --git a/dev/tutorials/installation/index.html b/dev/tutorials/installation/index.html index 13625f505..8b4b58293 100644 --- a/dev/tutorials/installation/index.html +++ b/dev/tutorials/installation/index.html @@ -3,4 +3,4 @@ using Pkg Pkg.activate("FOLDER_PATH") Pkg.resolve() -end

      Use slash / for the folder path.

      +end

      Use slash / for the folder path.

      diff --git a/dev/tutorials/parallelcoordinates/index.html b/dev/tutorials/parallelcoordinates/index.html index ce415dd0b..7cd8f2297 100644 --- a/dev/tutorials/parallelcoordinates/index.html +++ b/dev/tutorials/parallelcoordinates/index.html @@ -24,4 +24,4 @@ 25599 │ 0.112385 0.496 64 A (0.719221, 0.888091) 0.262 25600 │ 0.109979 0.498 64 A (0.719221, 0.888091) 0.258 2 columns and 25585 rows omitted, Point{2, Float32}[[0.49371386, 0.5440313], [0.5630452, 0.50400287], [0.5630452, 0.4239459], [0.49371386, 0.38391745], [0.4243825, 0.4239459], [0.4243825, 0.50400287], [0.5378472, 0.6178857], [0.61455333, 0.56901854], [0.6522695, 0.4862579], [0.6388263, 0.39630732] … [0.93907887, 0.6439135], [0.9450873, 0.29968786], [0.8333667, 0.12432156], [0.61803544, 1.9428903f-16], [0.3693923, 2.7755576f-17], [0.15406103, 0.12432156], [0.029739477, 0.3396528], [0.04834886, 0.6439135], [0.26820713, 0.88809085], [0.7192206, 0.88809085]])

      Plot PCPs

      plot_parallelcoordinates(results_plot,[5,3,2]; # this selects channel 5,3 & 2
-    mapping = (color = :coefname, y = :estimate))
      Important

      the following is still outdated...

      Column Mappings for PCPs

      Since PCPs use a DataFrame as an input, the library needs to know the names of the columns used for plotting.

      For more informations about mapping values, look into the Mapping Data section of the documentation.

      While there are multiple default values that are checked in that order if they exist in the DataFrame, a custom name might need to be choosen for:

      y

      Default is (:y, :estimate, :yhat).

      channel

      Default is :channel.

      color

      XXX Default is :coef.

      time

      Default is :time.

      + mapping = (color = :coefname, y = :estimate))
      Important

      the following is still outdated...

      Column Mappings for PCPs

      Since PCPs use a DataFrame as an input, the library needs to know the names of the columns used for plotting.

      For more informations about mapping values, look into the Mapping Data section of the documentation.

      While there are multiple default values that are checked in that order if they exist in the DataFrame, a custom name might need to be choosen for:

      y

      Default is (:y, :estimate, :yhat).

      channel

      Default is :channel.

      color

      XXX Default is :coef.

      time

      Default is :time.

      diff --git a/dev/tutorials/topoplot/index.html b/dev/tutorials/topoplot/index.html index 1127309ec..24c408320 100644 --- a/dev/tutorials/topoplot/index.html +++ b/dev/tutorials/topoplot/index.html @@ -7,4 +7,4 @@ df = DataFrame(:estimate => data[:,340,1]) plot_topoplot(df; positions = positions)

      Giving the Positions

      Since the topo plot needs the positions of the sensors they have to be put into the drawing function. But there are multiple options (In order of prioritization):

      To get the positions from the labels we use a database.

      Column Mappings for Topo Plots

      When using topo plots with a DataFrame as an input, the library needs to know the names of the columns used for plotting.

      For more informations about mapping values look into the Mapping Data section of the documentation.

      While there are multiple default values, that are checked in that order if they exist in the DataFrame, a custom name might need to be choosen for:

      Note that only one of positions or labels have to be set to draw a topo plot. If both are set, positions takes precedence, labels might be used for labelling electrodes in TopoPlots.jl

      (...,mapping=(;))

      :y plotting function looks in the default columns of mapping

      cfgDefault = UnfoldMakie.PlotConfig()
 cfgDefault.mapping.y
      (:estimate, :yhat, :y)

      positions

      cfgDefault.mapping.positions #hide

      labels

      cfgDefault.mapping.labels #hide

      label_text (boolean)

      Indicates whether label should drawn next to their position. Obviously the labels have to be provided: plot_topoplot(...; labels=[...])

      plot_topoplot(...;visual=(;label_text=true))

      label_scatter (boolean)

      Indicates whether the dots should be drawn at the given positions.

      plot_topoplot(...;visual=(;label_scatter=true))

      data, positions = TopoPlots.example_data()
-plot_topoplot(data[1:4,340,1]; visual = (; label_scatter = false), labels=["O1", "F2", "F3", "P4"])
      +plot_topoplot(data[1:4,340,1]; visual = (; label_scatter = false), labels=["O1", "F2", "F3", "P4"]) diff --git a/dev/tutorials/topoplotseries/index.html b/dev/tutorials/topoplotseries/index.html index 6d8b41695..c285f3923 100644 --- a/dev/tutorials/topoplotseries/index.html +++ b/dev/tutorials/topoplotseries/index.html @@ -5,4 +5,4 @@ using CairoMakie using TopoPlots

      Plot Topo Plots Series

      Giving the Data

      In case you do not already have data, you can get example data from the TopoPlots module. You can do it like this:

      data, positions = TopoPlots.example_data()
 df = UnfoldMakie.eeg_matrix_to_dataframe(data[:,:,1], string.(1:length(positions)));
      Δbin = 80
-plot_topoplotseries(df, Δbin; positions = positions)

      Positions

      You can give either positions, or labels. If both are provided, positions have priority

      plot_toposeries(...;mapping=(;key=value))

      mapping=(:y=(:estimate,:yhat,:y))

      visual=(;)

      label_text (boolean, false) Indicates whether label should drawn next to their position. The labels have to be given into the function seperately:

      Important

      currently bugged

      label_scatter (boolean, true) - Indicates whether the dots should be drawn at the given positions.

      +plot_topoplotseries(df, Δbin; positions = positions)

      Positions

      You can give either positions, or labels. If both are provided, positions have priority

      plot_toposeries(...;mapping=(;key=value))

      mapping=(:y=(:estimate,:yhat,:y))

      visual=(;)

      label_text (boolean, false) Indicates whether label should drawn next to their position. The labels have to be given into the function seperately:

      Important

      currently bugged

      label_scatter (boolean, true) - Indicates whether the dots should be drawn at the given positions.