Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ryan-odea authored Apr 10, 2024
1 parent 82dfb96 commit c182ddb
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# pytruncreg Overview
The `truncreg` function is designed to estimate gaussian truncated regression models, handling both left and right truncation with an option for scaling. The function requires `formula`, `data`, a truncation `point` and `direction` of truncation. This python package is a translation of the original `truncreg` R package [CRAN](https://cran.r-project.org/web/packages/truncreg/index.html) by Yves Croissant and Achim Zeileis.
The `truncreg` function is designed to estimate gaussian truncated regression models. The function requires `formula`, `data`, a truncation `point` and `direction` of truncation. This python package is a translation of the original `truncreg` R package [CRAN](https://cran.r-project.org/web/packages/truncreg/index.html) by Yves Croissant and Achim Zeileis.

## Parameters
- **formula** (str): String describing the model to be fitted in format `y ~ x_1 + x_2 + ... x_n`
Expand Down

0 comments on commit c182ddb

Please sign in to comment.