Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adds grid_type argument to datagrid #44

Closed
wants to merge 1 commit into from
Closed

adds grid_type argument to datagrid #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions marginaleffects/datagrid.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ def datagrid(
newdata=None,
FUN_numeric=lambda x: x.mean(),
FUN_other=lambda x: x.mode()[0], # mode can return multiple values
grid_type = "typical",
**kwargs
):
"""
Expand All @@ -25,6 +26,9 @@ def datagrid(
- `newdata`: DataFrame (one and only one of the `model` and `newdata` arguments can be used.)
- `FUN_numeric`: The function to be applied to numeric variables.
- `FUN_other`: The function to be applied to other variable types.
- `grid_type`:
* "typical": variables whose values are not explicitly specified by the user in `...` are set to their mean or mode, or to the output of the functions supplied to `FUN_type` arguments.
* "counterfactual": the entire dataset is duplicated for each combination of the variable values specified in `...`. Variables not explicitly supplied to `datagrid()` are set to their observed values in the original dataset.

Returns:

Expand Down Expand Up @@ -57,6 +61,9 @@ def datagrid(
if model is None and newdata is None:
raise ValueError("One of model or newdata must be specified")

if grid_type == "counterfactual":
return datagridcf(**kwargs, model=model, newdata=newdata)

if newdata is None:
newdata = get_modeldata(model)

Expand Down
Loading