Skip to content

vignettes: explain proportional baseline#70

Open
carmen-cabrera wants to merge 1 commit into
mainfrom
codex/proportional-baseline-visual
Open

vignettes: explain proportional baseline#70
carmen-cabrera wants to merge 1 commit into
mainfrom
codex/proportional-baseline-visual

Conversation

@carmen-cabrera

Copy link
Copy Markdown
Collaborator

Summary

  • clarifies the proportional baseline narrative in the coverage-bias vignette
  • replaces the previous coverage-bias/population plot with a two-panel visual
  • shows observed user counts against the constant-coverage baseline and residual departures from that baseline
  • adds a NEWS note for the vignette improvement

Checks

  • git diff --check
  • local pkgdown preview built successfully

Closes #67

@carmen-cabrera carmen-cabrera requested a review from fcorowe as a code owner June 14, 2026 13:17

@fcorowe fcorowe left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking good overall, and the new visual addresses #67 nicely. I found one small wording issue to tighten before merge: the prose should distinguish the count residual from the default selected residual returned by validate_bias_residual_structure().


We can use the function `validate_bias_residual_structure()` from `debiasR` to estimate this proportional baseline and inspect the
residual structure, i.e. the differences between observed and expected user counts.
`debiasR::validate_bias_residual_structure()` calculates this baseline and

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small wording fix before merge: this paragraph says the function returns residuals as observed-minus-expected user counts, but the default selected residual from validate_bias_residual_structure() is coverage_score_residual. Could we rephrase to make both residual concepts explicit?

Suggested replacement:

`debiasR::validate_bias_residual_structure()` calculates this baseline and
returns expected user counts plus several residual measures for each LAD. These
include count residuals, defined as observed user counts minus the counts
expected under constant coverage, and the default `coverage_score_residual`,
defined as local coverage minus overall coverage.

@fcorowe fcorowe added the documentation Improvements or additions to documentation label Jun 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

vignettes: explain proportional baseline

2 participants