Function write_plot

alphapy/plots.py:211–283

r"""Save the plot to a file, or display it interactively. Parameters ---------- vizlib : str The visualization library: ``'matplotlib'``, ``'seaborn'``, or ``'bokeh'``. plot : module Plotting context, e.g., ``plt``. plot_type : str Type of plot to

(vizlib, plot, plot_type, tag, directory=None)

#

def write_plot(vizlib, plot, plot_type, tag, directory=None):
    r"""Save the plot to a file, or display it interactively.

    Parameters
    ----------
    vizlib : str
        The visualization library: ``'matplotlib'``, ``'seaborn'``,
        or ``'bokeh'``.
    plot : module
        Plotting context, e.g., ``plt``.
    plot_type : str
        Type of plot to generate.
    tag : str
        Unique identifier for the plot.
    directory : str, optional
        The full specification for the directory location. if
        ``directory`` is *None*, then the plot is displayed
        interactively.

    Returns
    -------
    None : None.

    Raises
    ------
    ValueError
        Unrecognized data visualization library.

    References
    ----------

    Visualization Libraries:

    * Matplotlib : http://matplotlib.org/
    * Seaborn : https://seaborn.pydata.org/
    * Bokeh : http://bokeh.pydata.org/en/latest/

    """

    # Validate visualization library

    if (vizlib == 'matplotlib' or
       vizlib == 'seaborn' or
       vizlib == 'bokeh'):
        # supported library
        pass
    elif vizlib == 'plotly':
        raise ValueError("Unsupported data visualization library: %s" % vizlib)
    else:
        raise ValueError("Unrecognized data visualization library: %s" % vizlib)

    # Save or display the plot

    if directory:
        if vizlib == 'bokeh':
            file_only = ''.join([plot_type, USEP, tag, '.html'])
        else:
            file_only = ''.join([plot_type, USEP, tag, '.png'])