LinearTrend.plot_curve

LinearTrend.plot_curve(curve, n_samples=10, hdi_probs=None, random_seed=None, subplot_kwargs=None, sample_kwargs=None, hdi_kwargs=None, include_changepoints=True, axes=None, same_axes=False, colors=None, legend=None, sel_to_string=None)

Plot the curve samples from the trend.

Parameters:

curvexr.DataArray

DataArray with the curve samples.

n_samplesint, optional

Number of samples

hdi_probsfloat | list[float], optional

HDI probabilities. Defaults to None which uses arviz default for stats.ci_prob which is 94%

random_seedint | random number generator, optional

Random number generator. Defaults to None

subplot_kwargsdict, optional

Keyword arguments for the subplots, by default None.

sample_kwargsdict, optional

Keyword arguments for the samples, by default None.

hdi_kwargsdict, optional

Keyword arguments for the HDI, by default None.

include_changepointsbool, optional

Include the change points in the plot, by default True.

axesnpt.NDArray[plt.Axes], optional

Axes to plot the curve, by default None.

same_axesbool, optional

Use the same axes for the samples, by default False.

colorsIterable[str], optional

Colors for the samples, by default None.

legendbool, optional

Include a legend in the plot, by default None.

sel_to_stringSelToString, optional

Function to convert the selection to a string, by default None.

Returns:

tuple[plt.Figure, npt.NDArray[plt.Axes]]

Tuple with the figure and the axes.