Skip to content

Conversation

@ajinkya-k
Copy link
Contributor

@ajinkya-k ajinkya-k commented Aug 8, 2025

#607 pointed out that the API doc is missing for quite a few methods. This PR adds them.

Also removes lm and glm from the list of methods applied to fit objects in docs/index.md

Tracker

  • adjr2: adjusted R² for a linear model (an alias for adjr²)
  • aic: Akaike's Information Criterion
  • aicc: corrected Akaike's Information Criterion for small sample sizes
  • bic: Bayesian Information Criterion
  • coef: estimates of the coefficients in the model
  • confint: confidence intervals for coefficients
  • coeftable
  • cooksdistance: Cook's distance for each observation
  • deviance: measure of the model fit, weighted residual sum of squares for lm's
  • dispersion: dispersion (or scale) parameter for a model's distribution
  • dof: number of degrees of freedom consumed in the model
  • dof_residual: degrees of freedom for residuals, when meaningful
  • fitted: fitted values of the model
  • loglikelihood: log-likelihood of the model
  • modelmatrix: design matrix
  • nobs: number of rows, or sum of the weights when prior weights are specified
  • nulldeviance: deviance of the model with all predictors removed
  • nullloglikelihood: log-likelihood of the model with all predictors removed
  • predict: predicted values of the dependent variable from the fitted model
  • r2: R² of a linear model (an alias for r²)
  • residuals: vector of residuals from the fitted model
  • response: model response (a.k.a the dependent variable)
  • stderror: standard errors of the coefficients
  • vcov: variance-covariance matrix of the coefficient estimates

fixes #607

@codecov
Copy link

codecov bot commented Aug 8, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.82%. Comparing base (8f58b34) to head (94b73e3).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #608   +/-   ##
=======================================
  Coverage   94.82%   94.82%           
=======================================
  Files           8        8           
  Lines        1044     1044           
=======================================
  Hits          990      990           
  Misses         54       54           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

missing API documentation for methods applied to fitted models

1 participant