How to use the probscale.viz.probplot function in probscale

To help you get started, we’ve selected a few probscale examples, based on popular ways it is used in public projects.

Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.

github Geosyntec / wqio / wqio / viz.py View on Github external
when drawing the scatter points and best-fit line, respectively.
    return_results : bool (default = False)
        If True a dictionary of results of is returned along with the
        figure. Keys are:
            q - array of quantiles
            x, y - arrays of data passed to function
            xhat, yhat - arrays of modeled data plotted in best-fit line
            res - a statsmodels Result object.

    Returns
    -------
    fig : matplotlib.Figure
    result : dictionary of linear fit results.

    """
    output = probscale.viz.probplot(
        data,
        ax=ax,
        plottype=axtype,
        probax="x",
        datalabel=ylabel,
        problabel=xlabel,
        datascale=yscale,
        scatter_kws=scatter_kws,
        line_kws=line_kws,
        bestfit=bestfit,
        return_best_fit_results=return_results,
    )
    return output