Skip to content

Marius Pull Request #47

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

Closed
leonhaufe wants to merge 4 commits into from
Closed

Marius Pull Request #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
358839e
Changes to be committed:
marius-ui Jan 21, 2025
ebeecf2
I described scene in ParallelPlots
marius-ui Jan 22, 2025
55eff44
I described the return type of scene in README
marius-ui Jan 22, 2025
9c4c2ef
I described what the function returns
marius-ui Jan 22, 2025
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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,5 +96,16 @@ 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")

### 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.
13 changes: 13 additions & 0 deletions src/ParallelPlots.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -48,6 +52,15 @@ ParallelPlot(data::DataFrame; normalize::Bool=false)
- `title::String`:
- `ax_label::[String]`:


# Returns
-`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
julia> using ParallelPlots
Expand Down
Loading