fix: update tidy.fixest() docs to use vcov, add cluster/vcov tests#1276
Open
LeonidasZhak wants to merge 1 commit into
Open
fix: update tidy.fixest() docs to use vcov, add cluster/vcov tests#1276LeonidasZhak wants to merge 1 commit into
LeonidasZhak wants to merge 1 commit into
Conversation
- Update @param ... to reference vcov (modern) instead of deprecated se - Document vcov formula syntax for clustering (~Product + Year) - Add vcov='hetero' example alongside clustered SE example - Add tests for cluster argument (multi-way, single, with conf.int) - Add tests for vcov argument (string, formula, equivalence with se) - Regenerate fixest Rd files from roxygen source
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Updates
tidy.fixest()documentation to reference the modernvcovargument instead of the deprecatedseargument, and adds comprehensive tests for clustered SE functionality.Problem
The current
tidy.fixest()documentation:seargument as the primary way to specify robust/clustered SEsvcov = ~cluster)clusterargument or the newervcovargumentFix
Documentation (R/fixest.R):
@param ...to documentvcovas the primary argument (string like"hetero"or formula like~Product + Year)seis accepted but deprecatedse = "threeway"example withvcov = ~Product + Yearandvcov = "hetero"Tests (tests/testthat/test-fixest.R):
clusterargument: multi-way clustering, single cluster, conf.int integration, threeway SEvcovargument: string equivalence withse, formula equivalence withcluster, conf.int integrationValidation
roxygen2::roxygenise()regenerated Rd files successfullyFiles changed
R/fixest.R— Updated docs and examplestests/testthat/test-fixest.R— Added 2 new test blocks (37 lines of tests)man/tidy.fixest.Rd,man/augment.fixest.Rd,man/glance.fixest.Rd— Regenerated