reV.qa_qc.summary.SummaryPlots

class SummaryPlots(summary)[source]

Bases: PlotBase

Plot summary data for QA/QC

Parameters:

summary (str | pandas.DataFrame) – Summary DataFrame or path to summary .csv

Methods

dist_plot(value[, out_path])

Plot distribution plot of value using seaborn.distplot

dist_plotly(value[, out_path])

Plot histogram of value using plotly

scatter(summary_csv, out_dir, value[, ...])

Create scatter plot for given value in summary table and save to out_dir

scatter_all(summary_csv, out_dir[, ...])

Create scatter plot for all summary stats in summary table and save to out_dir

scatter_plot(value[, cmap, out_path])

Plot scatter plot of value versus longitude and latitude using pandas.plot.scatter

scatter_plotly(value[, cmap, out_path])

Plot scatter plot of value versus longitude and latitude using plotly

Attributes

columns

Available columns in summary table

data

Data to plot

summary

Summary table

property summary

Summary table

Returns:

pandas.DataFrame

property columns

Available columns in summary table

Returns:

list

scatter_plot(value, cmap='viridis', out_path=None, **kwargs)[source]

Plot scatter plot of value versus longitude and latitude using pandas.plot.scatter

Parameters:
  • value (str) – Column name to plot as color

  • cmap (str, optional) – Matplotlib colormap name, by default ‘viridis’

  • out_path (str, optional) – File path to save plot to, by default None

  • kwargs (dict) – Additional kwargs for plotting.dataframes.df_scatter

scatter_plotly(value, cmap='Viridis', out_path=None, **kwargs)[source]

Plot scatter plot of value versus longitude and latitude using plotly

Parameters:
  • value (str) – Column name to plot as color

  • cmap (str | px.color, optional) – Continuous color scale to use, by default ‘Viridis’

  • out_path (str, optional) – File path to save plot to, can be a .html or static image, by default None

  • kwargs (dict) – Additional kwargs for plotly.express.scatter

dist_plot(value, out_path=None, **kwargs)[source]

Plot distribution plot of value using seaborn.distplot

Parameters:
  • value (str) – Column name to plot

  • out_path (str, optional) – File path to save plot to, by default None

  • kwargs (dict) – Additional kwargs for plotting.dataframes.dist_plot

dist_plotly(value, out_path=None, **kwargs)[source]

Plot histogram of value using plotly

Parameters:
  • value (str) – Column name to plot

  • out_path (str, optional) – File path to save plot to, by default None

  • kwargs (dict) – Additional kwargs for plotly.express.histogram

classmethod scatter(summary_csv, out_dir, value, plot_type='plotly', cmap='viridis', **kwargs)[source]

Create scatter plot for given value in summary table and save to out_dir

Parameters:
  • summary_csv (str) – Path to .csv file containing summary table

  • out_dir (str) – Output directory to save plots to

  • value (str) – Column name to plot as color

  • plot_type (str, optional) – plot_type of plot to create ‘plot’ or ‘plotly’, by default ‘plotly’

  • cmap (str, optional) – Colormap name, by default ‘viridis’

  • kwargs (dict) – Additional plotting kwargs

classmethod scatter_all(summary_csv, out_dir, plot_type='plotly', cmap='viridis', **kwargs)[source]

Create scatter plot for all summary stats in summary table and save to out_dir

Parameters:
  • summary_csv (str) – Path to .csv file containing summary table

  • out_dir (str) – Output directory to save plots to

  • plot_type (str, optional) – plot_type of plot to create ‘plot’ or ‘plotly’, by default ‘plotly’

  • cmap (str, optional) – Colormap name, by default ‘viridis’

  • kwargs (dict) – Additional plotting kwargs

property data

Data to plot

Returns:

pandas.DataFrame | ndarray