summarise_lin()

liesel_gam.summarise_lin(term, samples, quantiles=(0.05, 0.5, 0.95), hdi_prob=0.9, indices=None)

Summarises a linear term.

Parameters:

• term (LinTerm | StrctLinTerm) – The term to summarise.

• samples (Mapping[str, Array | ndarray | bool | number | bool | int | float | complex]) – Dictionary of posterior samples. Must contain samples for the term’s coefficient.

• quantiles (Sequence[float], default: (0.05, 0.5, 0.95)) – Probability levels of quantiles to include.

• hdi_prob (float, default: 0.9) – Probability level for highest posterior density interval.

• indices (Sequence[int] | None, default: None) – Sequence of integers, selects coefficients or clusters to be included in the plot. If None, all coefficients/clusters are plotted.

Return type:

DataFrame