From 358839ecb8aa3185728333a27d5e7b1f945494b1 Mon Sep 17 00:00:00 2001 From: Marius Date: Tue, 21 Jan 2025 22:39:59 +0100 Subject: [PATCH 1/4] Changes to be committed: modified: README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 679d979..0c26629 100644 --- a/README.md +++ b/README.md @@ -96,5 +96,10 @@ Please read the [Docs](/docs/build/index.html) for further Information * move to `./docs` folder with command line * run `julia --project make.jl` +### Using CairoMakie +CairoMakie is a highest-quality and efficient 2D plotting backend for publications. It uses Cairo.jl to draw vector graphics to SVG,PNG and PDF +#### Activate CairoMakie + +Activate the backend by using CairoMakie and calling CairoMakie.activate!(type = "png") or CairoMakie.activate!(type = "svg") From ebeecf2ae14bfc385f333d5290299fa2b6a3de52 Mon Sep 17 00:00:00 2001 From: Marius Date: Wed, 22 Jan 2025 01:31:22 +0100 Subject: [PATCH 2/4] I described scene in ParallelPlots --- src/ParallelPlots.jl | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/ParallelPlots.jl b/src/ParallelPlots.jl index 395ebee..dc40083 100644 --- a/src/ParallelPlots.jl +++ b/src/ParallelPlots.jl @@ -39,6 +39,10 @@ end ```julia ParallelPlot(data::DataFrame; normalize::Bool=false) ``` +A `Scene` in CairoMakie is a container for rendering graphical elements. +It serves as the root structure that holds various plot objects, +axes, and decorations. In the context of this module, the scene is used +to render parallel coordinate lines and custom axis layouts. # Arguments @@ -48,6 +52,10 @@ ParallelPlot(data::DataFrame; normalize::Bool=false) - `title::String`: - `ax_label::[String]`: + +# Returns +- `Scene`: A visual representation of the parallel coordinates plot. + # Examples ```@example julia> using ParallelPlots From 55eff4489a4579211e5f4d0beb7c46960bd3e0ee Mon Sep 17 00:00:00 2001 From: Marius Date: Wed, 22 Jan 2025 02:00:23 +0100 Subject: [PATCH 3/4] I described the return type of scene in README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 0c26629..988b37d 100644 --- a/README.md +++ b/README.md @@ -103,3 +103,9 @@ CairoMakie is a highest-quality and efficient 2D plotting backend for publicatio #### Activate CairoMakie Activate the backend by using CairoMakie and calling CairoMakie.activate!(type = "png") or CairoMakie.activate!(type = "svg") + +### Overview + +This module provides a way to visualize data using parallel coordinates plots. A parallel coordinates plot is a common way of visualizing multivariate data by drawing lines connecting data points across parallel axes. + +The key output is a **Scene**, which is a CairoMakie object that holds the graphical rendering of your plot. The `Scene` serves as the container for all visual components, including axes and plotted lines. \ No newline at end of file From 9c4c2efd9a19b46a46626b81999977d7e4d88591 Mon Sep 17 00:00:00 2001 From: Marius Date: Wed, 22 Jan 2025 20:40:40 +0100 Subject: [PATCH 4/4] I described what the function returns --- src/ParallelPlots.jl | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/ParallelPlots.jl b/src/ParallelPlots.jl index dc40083..56b4012 100644 --- a/src/ParallelPlots.jl +++ b/src/ParallelPlots.jl @@ -54,7 +54,12 @@ to render parallel coordinate lines and custom axis layouts. # Returns -- `Scene`: A visual representation of the parallel coordinates plot. +-`pp`: ParallelPlot with Three values: + *`Figure`: provides a structure for layouts, subplots, and decorations. + *`Axis`: The axis elements representing the parallel dimensions of the plot. + *`Scene`: is the root container for graphical objects in CairoMakie. + + # Examples ```@example