Skip to content

Plot hierarchy

Ari Hartikainen edited this page Nov 17, 2019 · 8 revisions

NOTE: This currently WIP

function_name <- function_combine[{function_select1,function_select2},function_name1,(function_same_ax1, function_same_axis2)]

ArviZ has hierarchical plot-function structure.

Level 1: Atomic axis (1 axis)

The first level functions operates against one axis with one or more variables. These functions include:

  • plot_one_kde
  • plot_one_hist
  • plot_one_sample
  • plot_one_box
  • plot_one_rug
  • plot_one_text
  • plot_one_point

The common input and default values for these functions are

*arr: one or two {ndarray, str}
source: {xarray.Dataset, pandas.DataFrame,bokeh.ColumnDataSource}; optional
ax: {matplotlib.axis, bokeh.figure}; optional
labels: one or two {str, bokeh.Text}
line_kwargs: {dict}; optional
    line properties
fill_kwargs: {dict}; optional
    area properties
special_kwargs: {dict}; optional
    special plot specific properties
backend: {"matplotlib","bokeh"} 

Atomic plot returns the axis.

Level 1A: Atomic backend plot

Level 2: Multiple parameters, one atomic plot

Level 3: Multiple parameters, multiple atomic plots

  • plot_trace <- plot_grid[plot_grid[plot_dist, {plot_sample,plot_ess}]]
  • plot_forest <- plot_grid[plot_grid[{plot_box,plot_kde,plot_violin},plot_point,plot_point]]

Level X: Specialized plots

  • plot_posterior <- plot_grid[(plot_dist,plot_text)]

Level Y: Dashboard / PlotGrid

  • plot_dashboard
  • plot_grid
Clone this wiki locally