Merge branch 'main' into erpPlotDocumentation

README.md

@@ -24,12 +24,12 @@ The supportet visualizations are:
 
 ![grafik](https://github.com/unfoldtoolbox/UnfoldMakie.jl/assets/10183650/af2801e5-cd64-4932-b84d-9abc1d8470ee)
 
-
-## Code Notes
+## Structure
+### Code Notes
 
 The code files can be found in the `src` folder.
 
-## Documentation Notes
+### Documentation Notes
 
 The documentation can be found in the `doc` folder. We use `Documenter.jl` and plan to use `Literate.jl` for future usage.
 In the `src` folder contained within it exists as "raw" `.md` files and in the `build` folder contained within it exists as `.html` after running the `make.jl` file.

docs/src/tutorials/butterfly.md

@@ -56,9 +56,11 @@ Default is `(:labels, :label, :topoLabels, :sensor, :nothing)`
 
 ## Configurations for Butterfly Plots
 
+
 Here we look into possible options for configuring the butterfly plot visualization using `(...; <name>=<value>, ...)`.
 This is the list of unique configuration (key values):
 
+
 - topoLegend (boolean)
 
 ### topoLegend (boolean)

docs/src/tutorials/designmatrix.md

@@ -30,6 +30,7 @@ plot_designmatrix(designmatrix(uf))
 
 # kwargs `plot_designmatrix(...; ...)`.
 
+
 - sortData (boolean,false)  - Indicating whether the data is sorted; using sortslices() of Base Julia. 
 
 
@@ -39,9 +40,8 @@ plot_designmatrix(designmatrix(uf); sortData=true)
 ```
 
 - standardizeData (boolean, false) - Indicating whether the data is standardized, mapping the values between 0 and 1. 
-
-
 - xTicks (number, nothing)
+
 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.

src/plot_topoplot.jl

@@ -1,6 +1,7 @@
 """
     function plot_topoplot!(f::Union{GridPosition, Figure}, plotData, ; positions=nothing, labels=nothing, kwargs...)
-    function plot_topoplot(plotData, ; positions=nothing, labels=nothing, kwargs...)
+
+    function plot_topoplot(plotData,; positions=nothing, labels=nothing, kwargs...)
 
 Plot a topo plot.
 ## Arguments:

src/plot_topoplotseries.jl

@@ -1,9 +1,5 @@
 """
     function plot_topoplotseries!(f::Union{GridPosition, Figure}, plotData::DataFrame, Δbin::Real; kwargs...)
-using GeometryBasics: attributes
-using Base: concatenate_setindex!
-using GeometryBasics: attributes
-using Base: _fieldnames
     function plot_topoplotseries!(plotData::DataFrame, Δbin::Real; kwargs...)
         
 
@@ -14,7 +10,7 @@ Plot a Topoplot Series.
 - `Δbin::Real`: A number for how large one bin should be. Δbin is in units of the `plotData.time` column
 - `useColorbar`: (default `true`) - show colorbar.
 
-### kwargs
+### key arguments
 
 - `combinefun` (default `mean`) can be used to specify how the samples within `Δbin` are combined.
 - `rasterize_heatmaps` (deault `true`) - enforce rasterization of the plot heatmap when saving in svg format.
@@ -49,14 +45,14 @@ function plot_topoplotseries!(
 
     # resolve columns with data
     config.mapping = resolveMappings(plotData, config.mapping)
-
     positions = getTopoPositions(; positions = positions, labels = labels)
 
 
     if "label" ∉ names(plotData)
         plotData.label = plotData.channel
     end
 
+
     ftopo = eeg_topoplot_series!(
         f,
         plotData,

test/test_toposeries.jl

@@ -12,6 +12,7 @@ end
     Δbin=80
     UnfoldMakie.plot_topoplotseries(df, Δbin; positions=positions, layout = (; useColorbar=true))
 
+
 end
 
 @testset "testing with colorbar" begin
@@ -44,4 +45,4 @@ end
 
     f
 
-end
+en