Skip to content

Document that the report summary covers only the step's tests - #345

Merged
kguidonimartins merged 1 commit into
masterfrom
docs/report-step-summary
Oct 16, 2026
Merged

kguidonimartins merged 1 commit into
masterfrom
docs/report-step-summary

Conversation

@kguidonimartins

Copy link
Copy Markdown
Collaborator

Summary

Documents existing behaviour; no code change.

bdc_create_report(data, workflow_step = "space")
  col_to_tests <- tests of this step present in data      # .rou, .urb, .equ, ...
  report rows   <- one per test in col_to_tests
  "Summary of all tests" <- bdc_summary_col(data[col_to_tests])   # this step only

bdc_summary_col(data)
  .summary <- every column starting with "."               # includes .uncer_terms from taxonomy

New @details in bdc_create_report() says the summary row counts only the step's tests and can be smaller than the .summary column.

Evidence

Seen in the regenerated space vignette (#344): the report's "Summary of all tests" is 8, the .summary column flags 9 (the extra record fails only .uncer_terms).

New test, .uncer_terms = c(F, F, T, T), .rou = c(T, T, T, F):

  • space report: .rou 1, .summary 1
  • bdc_summary_col(): 3 flagged

devtools::test(filter = "bdc_create_report"): FAIL 0 | PASS 54.

Merge Danger

Door: two-way

Blast Radius: docs

Help page and one test only.

🤖 Generated with Claude Code

https://claude.ai/code/session_019P8b9MT61Yto9NRYBksGtb

bdc_create_report() recomputes "Summary of all tests" from the tests of
the requested step, so in the space vignette it reports 8 records while
the .summary column, which bdc_summary_col() builds from every "." column
including .uncer_terms, flags 9. The help page now explains this and a
test pins it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019P8b9MT61Yto9NRYBksGtb
@kguidonimartins
kguidonimartins merged commit b526aff into master Oct 16, 2026
5 checks passed
@kguidonimartins
kguidonimartins deleted the docs/report-step-summary branch October 16, 2026 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant