vishelper.plot

class vishelper.plot.plot(x=None, y=None, df=None, kind=None, plot_function=None, ax=None, xlabel=None, ylabel=None, title=None, legend=None, legend_kwargs=None, ticks=None, labels=None, color=None, color_data=None, color_by=None, figsize=None, xlim=None, ylim=None, tight_layout=False, **kwargs)[source]

Makes a plot of one or more univariate or multivariate datasets.

Options for kind of plot:

Univariate, continuous data (y=None):

  • hist (histogram)

Bivariate, continous x continuous data:

  • scatter

  • line

Bivariate, categorical x continuous data:

  • boxplot

  • bar

  • barh (horizontal bar plot)

Multivariate, continuous data (x=None, y=None, df != None):

  • heatmap

Parameters

  • x (optional, default None) –

    Data or column name(s) to be plotted for univariate plots, along the x-axis for continuous x continuous data, or categorical data for categorical x continuous data.

    • For one dataset: list or np.array of x-data or str denoting column of df to use for x-data.

    • More than one dataset: list of list of x-data sets or list of str with columns to be used for x-data.

    • If None, df must be provided and kind must be ‘heatmap’.

  • y (optional) – Univariate: None (default) For one bivariate dataset: list or np.array of y-data or str denoting column of df to use for y-data. More than one bivariate dataset: list of list of y-data sets or list of str with columns to be used for y-data.

  • kind (str, optional) –

    Type of plot. Defaults to None, which implies plot_function must be given. Options for kind:

    Univariate, continuous data (y=None):

    • hist (histogram)

    Bivariate, continous x continuous data:

    • scatter

    • line

    Bivariate, categorical x continuous data:

    • boxplot

    • bar

    • barh (horizontal bar plot)

    Multivariate, continuous data (x=None, y=None, df != None):

    • heatmap

  • df – Dataframe containing the data to be plotted. Default None. Data must be provided in x (and y if bivariate)

  • plot_function – Default None. If “kind” is not given, can provide a plot function with the form plot_function(x, y, ax, **kwargs) or plot_function(x, ax, **kwargs).

  • ax (matplotlib.axes._subplots.AxesSubplot, optional) – Matplotlib axes handle. Default is None and a new ax is generated along with the fig.

  • xlabel (str, optional) – Label for x axis. Default None.

  • ylabel (str, optional) – Label for y axis. Default None.

  • title (str, optional) – Plot title. Default None.

  • legend (bool, optional) – A legend will be displayed if legend=True or legend=None and more than one thing is being plot. Default None.

  • ( (legend_kwargs) – obj`dict`, optional): Dictionary of keyword arguments for legend (see legend for more when legend will be displayed). Default None.

  • labels (list of str, optional) – List of labels for legend. Default None. If legend is True, and no labels are provided, labels will be “Set N” where N is the ordering of the inputs.

  • ticks (list of str, optional) – List of tick labels. Default None.

  • color (str or list of str, optional) – Color to plot. List of colors if there is more than one thing being plot. Default is None, in which case, if color_data is also None, default colors from vishelper.config.formatting[“color.all”] will be used.

  • color_data (list of str, optional) – If provided, list should be the same length of the data, providing an individual color for each data point. Default None in which case all points will be colored according to color argument.

  • color_by (str) – Which column to color by if providing a dataframe in df

  • figsize (tuple, optional) – Figure size. Default is None and plot will be sized based on vishelper.config.formatting[‘figure.figsize’].

  • xlim (tuple, optional) – Tuple of minimum and maximum x values to plot (xmin, xmax). Default is None and matplotlib chooses these values.

  • ylim (tuple, optional) – Tuple of minimum and maximum y values to plot (ymin, ymax). Default is None and matplotlib chooses these values.

  • tight_layout (bool, optional) – Envokes plt.tight_layout() to ensure enough space is given to plot elements

  • **kwargs – These kwargs are any that are relevant to the plot kind provided.

Returns

Matplotlib figure object ax (matplotlib.axes._subplots.AxesSubplot): Axes object with the plot(s)

Return type

fig (matplotlib.figure.Figure)