Cleanup fit method arguments
#622
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Dec 22, 2025
List all arguments for all fit methods (`lm`, `glm`, `fit(LinearModel, ...)` and `fit(GeneralizedLinearModel, ...)` so that users get more friendly errors about the function they called when they make mistakes. This matters especially given the large number of arguments which makes an error likely. This requires some refactoring, notably using `nothing` as a default value instead of vector in the matrix method to match the formula method. Also improve docs: describe keyword arguments in all docstrings instead of referring to `fit`, avoid repeating them in signature. In the process I found a bug where weights were ignored by `negbin`. New tested values match R up to three decimals (this is tested more thoroughly via `glm` tests).
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #622 +/- ##
==========================================
- Coverage 96.98% 96.93% -0.06%
==========================================
Files 8 8
Lines 1196 1206 +10
==========================================
+ Hits 1160 1169 +9
- Misses 36 37 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
andreasnoack
approved these changes
Dec 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
List all arguments for all fit methods (
lm,glm,fit(LinearModel, ...)andfit(GeneralizedLinearModel, ...)so that users get more friendly errors about the function they called when they make mistakes. This matters especially given the large number of arguments which makes an error likely. This requires some refactoring, notably usingnothingas a default value instead of vector in the matrix method to match the formula method.Also improve docs: describe keyword arguments in all docstrings instead of referring to
fit, avoid repeating them in signature.In the process I found a bug where weights were ignored by
negbin. New tested values match R up to three decimals (this is tested more thoroughly viaglmtests).