API Reference#

This is an example on how to document the API of your own project.

Models#

OLS#

NormodOLS(*[, fit_intercept, copy_X, ...])

Normod in OLS.

GAM#

`gam.GAM`([mu_formula])	Generalized Additive Model (GAM) implemented using the `mgcv` package in R.
`gam.GAMLS`([mu_formula, sigma_formula])	Generalized Additive Model with Location-Scale (GAMLSS) implemented using the `mgcv` package in R.
`gam.GAMLSS`([mu_formula, sigma_formula, ...])	Generalized Additive Models for Location, Scale, and Shape (GAMLSS) implemented using the `mgcv` package in R.

Meta-regression#

metareg.NormodMetaregLS([fit_scale])

Datasets#

`datasets.make_gaussian`(n, interpolate_mu[, ...])	import numpy as np
`datasets.make_lss_SHASHo2`(n, interpolate_mu)	Simulate LSS data with specified interpolations for mu, sigma, nu, and tau.

Plotting#

plotting.plot_scatter_with_lines(x, y, lines)

Atypicality scoring#

`atypicality.multi_atypicality_scorer`(Z)
`atypicality.multi_roc_auc_score`(y_true, ...)

Metrics#

`metrics.logarithmic_score`(y_true, ...)
`metrics.calibration_descriptives`(x)	Skewness and kurtosis and their standard errors as implement by SPSS