Docs: Update Vignette and Readme#87
Merged
Merged
Conversation
Description: This PR updates the BUILD_PNADC_PANEL.Rmd vignette (which reflects on the main README.md) to align with the official Data Zoom methodological guidelines regarding panel attrition and individual tracking. Key Changes: Terminology Fix: Renamed the "Attrition" section to "Identification Rates". Added a methodological note clarifying that "Attrition" strictly applies to the dropout of households, whereas tracking individuals is referred to as "Identification Rates". Table Update: Replaced the outdated Stata comparison table with the newly calculated unconditional tracking rates (Base Line) for Waves 1 through 5. Accurate Metrics: The new table now correctly displays the weighted averages across multiple panels, comparing the Basic and Advanced identification algorithms, including the exact percentage point differences between them. Clarified Denominator: Added a footnote explaining that the universal denominator used for these percentages is the absolute total of raw lines from Wave 1.
**Description:** This PR updates the package documentation (`README.md` and Vignettes) to accurately reflect the recent methodological upgrades to the PNADC panel identification algorithms. **Key Documentation Updates:** * **Parameter Updates (`LOAD_PNADC.Rmd`):** Replaced all references and usage examples of the legacy `advanced` parameter with the new granular options (`advanced_1`, `advanced_2`, and `advanced_3`). Clarified the specific behavior of each stage. * **Methodological Explanations (`BUILD_PNADC_PANEL.Rmd`):** Expanded the methodology section to detail the progressive multi-stage approach. Added a comprehensive explanation of the new Graph Theory-based Fuzzy Matching (Stage 3) and how it handles typographical errors in the IBGE data. * **Identification Rates (README & Vignettes):** Updated the performance tables with the new baseline metrics. The documentation now clearly highlights the significant tracking improvements, specifically the ~5.5 p.p. retention gain achieved by Stage 3 in Wave 5 compared to the basic method. * **Terminology Standardization:** Enforced the Data Zoom methodological guideline across all documents, explicitly defining the distinction between *Household Attrition* and *Individual Identification Rates*. **Why this matters:** These updates ensure that users clearly understand the mechanics behind the new advanced stages and provide transparent, reproducible tracking rates that validate the robustness of the new Fuzzy Matching approach.
Vanndher
changed the title
Vanndher
changed the title
lauratregadas
approved these changes
May 26, 2026
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
2 participants
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.
Description:
This PR updates the package documentation (
README.mdand Vignettes) to accurately reflect the recent methodological upgrades to the PNADC panel identification algorithms.Key Documentation Updates:
LOAD_PNADC.Rmd): Replaced all references and usage examples of the legacyadvancedparameter with the new granular options (advanced_1,advanced_2, andadvanced_3). Clarified the specific behavior of each stage.BUILD_PNADC_PANEL.Rmd): Expanded the methodology section to detail the progressive multi-stage approach. Added a comprehensive explanation of the new Graph Theory-based Fuzzy Matching (Stage 3) and how it handles typographical errors in the IBGE data.Why this matters:
These updates ensure that users clearly understand the mechanics behind the new advanced stages and provide transparent, reproducible tracking rates that validate the robustness of the new Fuzzy Matching approach.