shnitsel.clean.dispatch_plots

Functions

dispatch_plots(filtranda, plot_thresholds, ...)

Call filtration-related plotting functions depending on arguments

Module Contents

dispatch_plots(filtranda, plot_thresholds, plot_populations)

Call filtration-related plotting functions depending on arguments

Parameters:

• filtranda – Data according to which to filter

• plot_thresholds (bool | Sequence[float]) –

  • If True, will plot using check_thresholds with

  default quantiles - If a Sequence, will plot using check_thresholds with specified quantiles - If False, will not plot threshold plot

• plot_populations (bool | Literal['independent', 'intersections']) –

  • If True or 'intersections', will plot populations of

  trajectories satisfying intersecting conditions - If 'independent', will plot populations of trajectories satisfying conditions taken independently - If False, will not plot populations plot

Raises:

ValueError – If plot_populations is an invalid value