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.

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

Docs: Document Inference Defaults in quickstart.ipynb and docstrings #285

Open
s3alfisc opened this issue Feb 4, 2024 · 1 comment
Open
Labels
docs Improvements or additions to documentation good first issue Good for newcomers

Comments

@s3alfisc
Copy link
Member

s3alfisc commented Feb 4, 2024

Context

Currently, the documentation is silent on standard error defaults - would be good to add notes to the feols() and fepois() docs.

In alignment with fixest, the behavior is the following:

  • If no fixed effect is specified to be projected out, feols() and fepois() return "iid" standard errors.
  • If one (or more) fixed effects are specified via formula syntax, inference is clustered by the first fixed effect (CRV1 inference).
feols("Y ~ X + C(f1)", data = data) # no fixed effect specified via two-part formula syntax -> iid inference
feols("Y ~ X | f1", data = data) # fixed effect specified via two-part formula syntax -> CRV1 inference clustered by f1
feols("Y ~ X | f1 + f2", data = data) # two fixed effects specified via two-part formula syntax -> CRV1 inference clustered by the first fixed effect f1

To do

  • Add this information to the standard error section in the quickstart notebook.
  • Add this information to the docstrings of the vcov of feols() and fepois().
@s3alfisc s3alfisc added the docs Improvements or additions to documentation label Feb 4, 2024
@s3alfisc s3alfisc added the good first issue Good for newcomers label Feb 4, 2024
@NKeleher
Copy link
Contributor

NKeleher commented Feb 5, 2024

@s3alfisc - I can pick this up as some initial docs work. I can likely get to it this week.

@s3alfisc s3alfisc changed the title Document Inference Defaults Docs: Document Inference Defaults in quickstart.ipynb and docstrings May 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants