Skip to content

Commit 58cb26e

Browse files
committed
Docs: Update PNADC identification rates and refine attrition terminology
**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.
1 parent 30f424c commit 58cb26e

4 files changed

Lines changed: 218 additions & 192 deletions

File tree

README.Rmd

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ output: github_document
1010

1111
<!-- badges: start -->
1212
[![CRAN status](https://www.r-pkg.org/badges/version/datazoom.social)](https://CRAN.R-project.org/package=datazoom.social)
13-
[![R build status](https://github.com/datazoompuc/datazoom.social/workflows/R-CMD-check/badge.svg)](https://github.com/datazoompuc/datazoom.social/actions?style=flat)
1413
[![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/grand-total/datazoom.social)](https://CRAN.R-project.org/package=datazoom.social)
1514
[![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/datazoom.social)](https://CRAN.R-project.org/package=datazoom.social)
1615
![Languages](https://img.shields.io/github/languages/count/datazoompuc/datazoom.social?style=flat)
@@ -31,12 +30,12 @@ In the first version of the package, the focus is on the [Continuous PNAD](https
3130

3231
# Installation
3332

34-
<!-- You can install the released version of `datazoom.social` from -->
35-
<!-- [CRAN](https://CRAN.R-project.org/package=datazoom.social) with: -->
33+
You can install the released version of `datazoom.social` from
34+
[CRAN](https://CRAN.R-project.org/package=datazoom.social) with:
3635

37-
<!-- ``` {r, eval=FALSE} -->
38-
<!-- install.packages("datazoom.social") -->
39-
<!-- ``` -->
36+
``` {r, eval=FALSE}
37+
install.packages("datazoom.social")
38+
```
4039

4140
You can install the development version of `datazoom.social` from GitHub with:
4241

@@ -57,8 +56,8 @@ devtools::load_all()
5756

5857
|||
5958
|---|---|
60-
| **[Continuous PNAD](#continuous-pnad)** | _Download PNADC of a range of quarters_ |
61-
| **[Panel Identification](#pnad-panel-identification)** | _Build a Panel of PNADC individuals_ |
59+
| **[`load_pnadc`](#continuous-pnad)** | _Download PNADC of a range of quarters_ |
60+
| **[`build_pnadc_panel`](#pnad-panel-identification)** | _Identify individuals throughout time_ |
6261

6362
</td></tr>
6463

@@ -96,4 +95,4 @@ A BibTeX entry for LaTeX users is:
9695
url = {https://datazoom.com.br/en/},
9796
year = {2024}}
9897
99-
```
98+
```

0 commit comments

Comments
 (0)