1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
//! This module provides implementations for vertical and horizontal box plots using the Plotly library.
//!
//! The `VerticalBoxPlot` and `HorizontalBoxPlot` structs allow for the creation and customization of box plots
//! with various options for data, layout, and aesthetics.
use bon::bon;
use plotly::{
box_plot::BoxPoints,
common::{Line as LinePlotly, Marker, Orientation},
BoxPlot, Layout, Trace as TracePlotly,
};
use polars::frame::DataFrame;
use crate::{
aesthetics::{line::Line, mark::Mark},
colors::Rgb,
texts::Text,
traits::layout::LayoutPlotly,
traits::plot::Plot,
traits::polar::Polar,
traits::trace::Trace,
};
/// A structure representing a vertical bar plot.
pub struct VerticalBoxPlot {
traces: Vec<Box<dyn TracePlotly + 'static>>,
layout: Layout,
}
#[bon]
impl VerticalBoxPlot {
/// Creates a new `VerticalBoxPlot`.
///
/// # Arguments
///
/// * `data` - A reference to the `DataFrame` containing the data to be plotted.
/// * `x` - A string specifying the column name to be used for the x-axis.
/// * `y` - A string specifying the column name to be used for the y-axis.
/// * `group` - An optional string specifying the column name to be used for grouping data points.
/// * `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).
/// * `colors` - An optional vector of `Rgb` values specifying the colors to be used for the plot.
/// * `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.
///
/// # Returns
///
/// Returns an instance of `VerticalBoxPlot`.
///
/// # Example
///
/// ```
/// VerticalBoxPlot::builder()
/// .data(&dataset)
/// .x("x variable")
/// .y("y variable")
/// .group("group")
/// .box_points(true)
/// .point_offset(-1.5)
/// .jitter(0.01)
/// .opacity(0.1)
/// .colors(vec![
/// Rgb(255, 0, 0),
/// Rgb(0, 255, 0),
/// Rgb(0, 0, 255),
/// ])
/// .plot_title(
/// Text::from("Box Plot")
/// .font("Arial")
/// .size(18)
/// )
/// .x_title(
/// Text::from("x variable")
/// .font("Arial")
/// .size(15)
/// )
/// .y_title(
/// Text::from("y variable")
/// .font("Arial")
/// .size(15)
/// )
/// .legend_title(
/// Text::from("group")
/// .font("Arial")
/// .size(15)
/// )
/// .build()
/// .plot();
/// ```
#[builder]
pub fn new(
data: &DataFrame,
x: String,
y: String,
group: Option<String>,
box_points: Option<bool>,
point_offset: Option<f64>,
jitter: Option<f64>,
// Marker
opacity: Option<f64>,
colors: Option<Vec<Rgb>>,
// Layout
plot_title: Option<Text>,
x_title: Option<Text>,
y_title: Option<Text>,
legend_title: Option<Text>,
) -> Self {
let x_col = x.as_str();
let y_col = y.as_str();
// Layout
let bar_mode = None;
let layout = Self::create_layout(bar_mode, plot_title, x_title, y_title, legend_title);
// Trace
let error = None;
let aditional_series = None;
let size = None;
let line_types = None;
let traces = Self::create_traces(
data,
x_col,
y_col,
group,
error,
box_points,
point_offset,
jitter,
aditional_series,
opacity,
size,
colors,
line_types,
);
Self { traces, layout }
}
}
impl LayoutPlotly for VerticalBoxPlot {}
impl Polar for VerticalBoxPlot {}
impl Mark for VerticalBoxPlot {}
impl Line for VerticalBoxPlot {}
impl Trace for VerticalBoxPlot {
fn create_trace(
data: &DataFrame,
x_col: &str,
y_col: &str,
group_name: Option<&str>,
#[allow(unused_variables)] error: Option<String>,
box_points: Option<bool>,
point_offset: Option<f64>,
jitter: Option<f64>,
marker: Marker,
#[allow(unused_variables)] line: LinePlotly,
) -> Box<dyn TracePlotly + 'static> {
let x_data = Self::get_string_column(data, x_col);
let y_data = Self::get_numeric_column(data, y_col);
let mut trace = BoxPlot::default().x(x_data).y(y_data);
if let Some(all) = box_points {
if all {
trace = trace.box_points(BoxPoints::All);
} else {
trace = trace.box_points(BoxPoints::False);
}
}
if let Some(point_position) = point_offset {
trace = trace.point_pos(point_position);
}
if let Some(jitter) = jitter {
trace = trace.jitter(jitter);
}
trace = trace.marker(marker);
if let Some(name) = group_name {
trace = trace.name(name);
}
trace
}
}
impl Plot for VerticalBoxPlot {
fn get_layout(&self) -> &Layout {
&self.layout
}
fn get_traces(&self) -> &Vec<Box<dyn TracePlotly + 'static>> {
&self.traces
}
}
/// A structure representing a horizontal box plot.
pub struct HorizontalBoxPlot {
traces: Vec<Box<dyn TracePlotly + 'static>>,
layout: Layout,
}
#[bon]
impl HorizontalBoxPlot {
/// Creates a new `HorizontalBoxPlot`.
///
/// # Arguments
///
/// * `data` - A reference to the `DataFrame` containing the data to be plotted.
/// * `x` - A string specifying the column name to be used for the x-axis.
/// * `y` - A string specifying the column name to be used for the y-axis.
/// * `group` - An optional string specifying the column name to be used for grouping data points.
/// * `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).
/// * `colors` - An optional vector of `Rgb` values specifying the colors to be used for the plot.
/// * `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.
///
/// # Returns
///
/// Returns an instance of `HorizontalBoxPlot`.
///
/// # Example
///
/// ```
/// HorizontalBoxPlot::builder()
/// .data(&dataset)
/// .x("x_variable")
/// .y("y_variable")
/// .group("group")
/// .box_points(true)
/// .point_offset(-1.5)
/// .jitter(0.01)
/// .opacity(0.1)
/// .colors(vec![
/// Rgb(255, 0, 0),
/// Rgb(0, 255, 0),
/// Rgb(0, 0, 255),
/// ])
/// .plot_title(
/// Text::from("Box Plot")
/// .font("Arial")
/// .size(18)
/// )
/// .x_title(
/// Text::from("x variable")
/// .font("Arial")
/// .size(15)
/// )
/// .y_title(
/// Text::from("y variable")
/// .font("Arial")
/// .size(15)
/// )
/// .legend_title(
/// Text::from("group")
/// .font("Arial")
/// .size(15)
/// )
/// .build()
/// .plot();
/// ```
#[builder]
pub fn new(
data: &DataFrame,
x: String,
y: String,
group: Option<String>,
box_points: Option<bool>,
point_offset: Option<f64>,
jitter: Option<f64>,
// Marker
opacity: Option<f64>,
colors: Option<Vec<Rgb>>,
// Layout
plot_title: Option<Text>,
x_title: Option<Text>,
y_title: Option<Text>,
legend_title: Option<Text>,
) -> Self {
let x_col = x.as_str();
let y_col = y.as_str();
// Layout
let bar_mode = None;
let layout = Self::create_layout(bar_mode, plot_title, x_title, y_title, legend_title);
// Trace
let error = None;
let aditional_series = None;
let size = None;
let line_type = None;
let traces = Self::create_traces(
data,
x_col,
y_col,
group,
error,
box_points,
point_offset,
jitter,
aditional_series,
opacity,
size,
colors,
line_type,
);
Self { traces, layout }
}
}
impl LayoutPlotly for HorizontalBoxPlot {}
impl Polar for HorizontalBoxPlot {}
impl Mark for HorizontalBoxPlot {}
impl Line for HorizontalBoxPlot {}
impl Trace for HorizontalBoxPlot {
fn create_trace(
data: &DataFrame,
x_col: &str,
y_col: &str,
group_name: Option<&str>,
#[allow(unused_variables)] error: Option<String>,
box_points: Option<bool>,
point_offset: Option<f64>,
jitter: Option<f64>,
marker: Marker,
#[allow(unused_variables)] line: LinePlotly,
) -> Box<dyn TracePlotly + 'static> {
let x_data = Self::get_numeric_column(data, x_col);
let y_data = Self::get_string_column(data, y_col);
let mut trace = BoxPlot::default()
.x(x_data)
.y(y_data)
.orientation(Orientation::Horizontal);
if let Some(all) = box_points {
if all {
trace = trace.box_points(BoxPoints::All);
} else {
trace = trace.box_points(BoxPoints::False);
}
}
if let Some(point_position) = point_offset {
trace = trace.point_pos(point_position);
}
if let Some(jitter) = jitter {
trace = trace.jitter(jitter);
}
trace = trace.marker(marker);
if let Some(name) = group_name {
trace = trace.name(name);
}
trace
}
}
impl Plot for HorizontalBoxPlot {
fn get_layout(&self) -> &Layout {
&self.layout
}
fn get_traces(&self) -> &Vec<Box<dyn TracePlotly + 'static>> {
&self.traces
}
}