Add support for spatial and nonspatial Wilkinson formulas #102
Conversation
This file contains 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
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.
This pull request adds the formula functionality described in #101. It consists of the following parts:
spreg/formula.py: the main formula implementation (parser and dispatcher), documentation, and doctestsspreg/__init__.py: add a line which imports the formula interface whenspregis loadednotebooks/formula_example.ipynb: a notebook showcasing the features ofspreg.from_formula()alongside textual descriptionsspreg/tests/test_formula.py: unit tests for thespreg.from_formula()function.Pursuant to this comment on #101, everything in this PR is fully backwards compatible. This is an add-on to the package which sits on top of existing code and provides another way for users to access it. Currently, the function dispatches to all of the spatial regression models. While it does not support regime regression or seemingly unrelated regression, it provides a solid base of code to which these features can be added.