Skip to content

Update vignette, documentation, fix checkbox missingness logic#9

Merged
rsh52 merged 1 commit into
mainfrom
codex/quality-report-clarifications
Jul 15, 2026
Merged

Update vignette, documentation, fix checkbox missingness logic#9
rsh52 merged 1 commit into
mainfrom
codex/quality-report-clarifications

Conversation

@rsh52

@rsh52 rsh52 commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Description

This PR clarifies the build_quality_report() documentation and refines how checkbox fields are evaluated. It separates meaningful no-selection states from missing checkbox data and ensures checkbox consistency checks respect form completion status.

Proposed Changes

  • Expand documentation for sparse_threshold, including applicable-row calculations, inclusive threshold behavior, and sensitivity implications.
  • Document the IQR outlier formula and how outlier_iqr_multiplier affects finding sensitivity.
  • Clarify the difference between progress = "auto", "show", and "none".
  • Reorganize the quality-report article with dedicated sections for report construction, missingness, and report structure.
  • Explain how form status, branching logic, events, and repeating instruments determine missingness applicability.
  • Treat explicit all-zero checkbox exports as an observed, meaningful no-selection state.
  • Continue treating an all-NA or blank checkbox set as missing on an applicable row.
  • Add the field-level informational finding checkbox_no_values_selected when no options are selected across applicable Unverified or Complete rows.
  • Restrict checkbox_none_with_other and checkbox_no_values_selected checks to applicable Unverified or Complete forms.
  • Document all mutually exclusive checkbox labels: None, No, Not applicable, N/A, NA, and None of the above.
  • Update tests to separately cover checked, all-zero, all-missing, Incomplete, and blank-status checkbox states.
  • Regenerate mock_quality_report to reflect the revised status rules.

Behavioral Notes

An all-zero checkbox set no longer contributes to missingness. It can produce one informational field-level finding when no options are selected anywhere across assessed rows. This finding is intended as a review prompt because the no-selection state may be valid.

Checkbox values on Incomplete forms or forms with blank completion status are not evaluated. A checked mutually exclusive option is only reported when selected with another option on an applicable Unverified or Complete form.

Validation

  • Full package test suite
  • Quality-report article rendering
  • Full pkgdown site build
  • lintr::lint_package()
  • air format --check .
  • git diff --check

Adds detection of checkbox fields where no options are selected (explicit no-selection state) as distinct from missing data. Updates checkbox value detection to differentiate between all-zero exports (observed no-selection) and all-NA/blank exports (missing). Includes new `checkbox_no_values_selected` info-level field finding and improves documentation of missingness and checkbox handling semantics.
@rsh52 rsh52 self-assigned this Jul 15, 2026
@rsh52 rsh52 added bug Something isn't working enhancement New feature or request labels Jul 15, 2026
@rsh52
rsh52 marked this pull request as ready for review July 15, 2026 19:26
@rsh52
rsh52 merged commit 474747b into main Jul 15, 2026
3 checks passed
@rsh52
rsh52 deleted the codex/quality-report-clarifications branch July 15, 2026 19:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant