Struct BoxPlot 

pub struct BoxPlot { /* private fields */ }

A structure representing a box plot.

The BoxPlot struct facilitates the creation and customization of box plots with various options for data selection, layout configuration, and aesthetic adjustments. It supports both horizontal and vertical orientations, grouping of data, display of individual data points with jitter and offset, opacity settings, and customizable markers and colors.

Arguments

• data - A reference to the DataFrame containing the data to be plotted.
• labels - A string slice specifying the column name to be used for the x-axis (independent variable).
• values - A string slice specifying the column name to be used for the y-axis (dependent variable).
• orientation - An optional Orientation enum specifying whether the plot should be horizontal or vertical.
• group - An optional string slice specifying the column name to be used for grouping data points.
• sort_groups_by - Optional comparator fn(&str, &str) -> std::cmp::Ordering to control group ordering. Groups are sorted lexically by default.
• box_points - An optional boolean indicating whether individual data points should be plotted along with the box plot.
• point_offset - An optional f64 value specifying the horizontal offset for individual data points when box_points is enabled.
• jitter - An optional f64 value indicating the amount of jitter (random noise) to apply to individual data points for visibility.
• opacity - An optional f64 value specifying the opacity of the plot markers (range: 0.0 to 1.0).
• color - An optional Rgb value specifying the color of the markers to be used for the plot. This is used when group is not specified.
• colors - An optional vector of Rgb values specifying the colors to be used for the plot. This is used when group is specified to differentiate between groups.
• plot_title - An optional Text struct specifying the title of the plot.
• x_title - An optional Text struct specifying the title of the x-axis.
• y_title - An optional Text struct specifying the title of the y-axis.
• legend_title - An optional Text struct specifying the title of the legend.
• x_axis - An optional reference to an Axis struct for customizing the x-axis.
• y_axis - An optional reference to an Axis struct for customizing the y-axis.
• legend - An optional reference to a Legend struct for customizing the legend of the plot (e.g., positioning, font, etc.).

Example

use polars::prelude::*;
use plotlars::{Axis, BoxPlot, Legend, Orientation, Plot, Rgb, Text};

let dataset = LazyCsvReader::new(PlPath::new("data/penguins.csv"))
    .finish()
    .unwrap()
    .select([
        col("species"),
        col("sex").alias("gender"),
        col("flipper_length_mm").cast(DataType::Int16),
        col("body_mass_g").cast(DataType::Int16),
    ])
    .collect()
    .unwrap();

BoxPlot::builder()
    .data(&dataset)
    .labels("species")
    .values("body_mass_g")
    .orientation(Orientation::Vertical)
    .group("gender")
    .box_points(true)
    .point_offset(-1.5)
    .jitter(0.01)
    .opacity(0.1)
    .colors(vec![
        Rgb(0, 191, 255),
        Rgb(57, 255, 20),
        Rgb(255, 105, 180),
    ])
    .plot_title(
        Text::from("Box Plot")
            .font("Arial")
            .size(18)
    )
    .x_title(
        Text::from("species")
            .font("Arial")
            .size(15)
    )
    .y_title(
        Text::from("body mass (g)")
            .font("Arial")
            .size(15)
    )
    .legend_title(
        Text::from("gender")
            .font("Arial")
            .size(15)
    )
    .y_axis(
        &Axis::new()
            .value_thousands(true)
    )
    .legend(
        &Legend::new()
            .border_width(1)
            .x(0.9)
    )
    .build()
    .plot();

Implementations

impl BoxPlot

pub fn builder<'f1, 'f2, 'f3, 'f4, 'f5, 'f6, 'f7>() -> BoxPlotBuilder<'f1, 'f2, 'f3, 'f4, 'f5, 'f6, 'f7>

Examples found in repository

examples/boxplot.rs (line 18)

fn main() {
    let dataset = LazyCsvReader::new(PlPath::new("data/penguins.csv"))
        .finish()
        .unwrap()
        .select([
            col("species"),
            col("sex").alias("gender"),
            col("flipper_length_mm").cast(DataType::Int16),
            col("body_mass_g").cast(DataType::Int16),
        ])
        .collect()
        .unwrap();

    BoxPlot::builder()
        .data(&dataset)
        .labels("species")
        .values("body_mass_g")
        .orientation(Orientation::Vertical)
        .group("gender")
        .box_points(true)
        .point_offset(-1.5)
        .jitter(0.01)
        .opacity(0.1)
        .colors(vec![Rgb(0, 191, 255), Rgb(57, 255, 20), Rgb(255, 105, 180)])
        .plot_title(Text::from("Box Plot").font("Arial").size(18))
        .x_title(Text::from("species").font("Arial").size(15))
        .y_title(Text::from("body mass (g)").font("Arial").size(15))
        .legend_title(Text::from("gender").font("Arial").size(15))
        .y_axis(&Axis::new().value_thousands(true))
        .legend(&Legend::new().border_width(1).x(0.9))
        .build()
        .plot();
}

Trait Implementations

impl Clone for BoxPlot

fn clone(&self) -> BoxPlot

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl PlotHelper for BoxPlot

fn get_layout(&self) -> &LayoutPlotly

fn get_traces(&self) -> &Vec<Box<dyn Trace + 'static>>

impl Serialize for BoxPlot

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.