summarise_1d_smooth()

summarise_1d_smooth()#

liesel_gam.summarise_1d_smooth(term, samples, newdata=None, quantiles=(0.05, 0.5, 0.95), hdi_prob=0.9, ngrid=150)[source]#

Creates a summary dataframe for a one-dimensional StrctTerm.

Parameters:

  • term (StrctTerm) – 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.

  • newdata (None | Mapping[str, Array | ndarray | bool | number | bool | int | float | complex], default: None) – Optional dictionary of covariate data at which to summarise the term. If None, a grid of length ngrid will be created internally, using the minimum and maximum observed values of this term’s input covariate.

  • 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.

  • ngrid (int, default: 150) – Number of covariate values in the grid used for summary, if newdata=None.

Return type:

DataFrame