Skip to content

Document the handoff to nomologR on the README, and fix the RC-day order - #85

Merged
JUhalt merged 1 commit into
masterfrom
docs/readme-handoff
Sep 28, 2026
Merged

JUhalt merged 1 commit into
masterfrom
docs/readme-handoff

Conversation

@JUhalt

@JUhalt JUhalt commented Sep 28, 2026 •

Copy link
Copy Markdown
Owner

The maintainer asked that each package's README document the handoff in its own section near the bottom. nomologR is adding the mirror section, "The handoff from contentvalidR", above its "Stability" section. Docs only: no code, no computed value, and no handoff change.

"The handoff to nomologR", just above References

  • What a handoff carries:
    • the carried and held-back items, each with its status, recommendation, and rule;
    • the scales;
    • each item's statistics, intervals, and criteria, and the panel's agreement;
    • two facts only the analyst knows: reverse_keyed (or character(0) if checked and none is) and response_scale.
  • Making one: a runnable content_handoff() call on the README's own first analysis. It shows the two carried items.
  • Passing it to nomologR: nomo_screen(responses, items = h) and nomo_run(responses, scales = h), shown but not run. Pass the whole handoff, not h$items.
  • Reading a handoff: the reader contract in ?content_handoff (State the handoff reader contract nomologR asked for, and record the joint 1.0 checklist #79).
    • Decisions come from carried and status, never re-derived from a statistic against its criterion or from the producer version.
    • recommendation is prose.
    • keying of NA means unknown.
    • nomologR uses the same wording in its section.
  • Versions: schema 1 has been frozen since 0.7.0, with additions only at the end. A version 2 would be produced beside version 1 for at least a release cycle. The nomologR reader is tested against producers 0.6.0 through 0.9.0, with 0.10.0 fixtures delivered today. The section links ?content_handoff, the handoff vignette, and the joint walkthrough.

Also

  • ROADMAP.md: release-candidate day on 2026-10-17 now runs in the order agreed with nomologR, so that nomologR's tests pass before either package tags:
    1. The 0.99.0 commit and its fixtures come first, with the commit recorded in the manifest.
    2. Then nomologR's suite runs.
    3. Then both packages tag, contentvalidR on exactly the commit the fixtures came from.
  • Version: opens 0.10.0.9000, with the development NEWS heading.

Verification

  • The README knits. The handoff chunk runs and prints "Clear 1" "Clear 2".
  • Spelling is clean.
  • tools/release-gate.R on this PR's head (be3097d), run in a detached worktree: build, smoke, and check all pass; R CMD check 0 errors, 0 warnings, 0 notes (the usual CRAN-incoming and V8 notes did not appear in this run). A first run failed only because repository.upenn.edu returned a transient 500 for the Krippendorff (2011) link; it answered 200 minutes later, and the rerun on the same commit passed.

🤖 Generated with Claude Code

The maintainer asked that each package's README document the handoff in
its own section near the bottom. "The handoff to nomologR", just above
References, says what a handoff carries, how to make one (with the
README's own fit), the two nomologR calls that read it, how to read its
decisions (the reader contract in ?content_handoff), and how schema 1 is
versioned. nomologR's README carries the mirror section, "The handoff
from contentvalidR", with the same reader-contract wording.

ROADMAP.md now gives the release-candidate day in the order agreed with
nomologR, so that nomologR's tests pass before either package tags: the
0.99.0 commit and its fixtures first, then nomologR's suite, then both
tags, contentvalidR's on exactly the commit the fixtures came from.

Opens the 0.10.0.9000 development version.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@JUhalt
JUhalt merged commit d3c57f4 into master Sep 28, 2026
8 checks passed
JUhalt added a commit that referenced this pull request Sep 29, 2026
Release contentvalidR 0.10.1

A documentation release. It stamps the version, release notes, citation
metadata, README, and roadmap for 0.10.1, which puts the handoff on the
front page:
- the README section "The handoff to nomologR", mirrored by nomologR's
  "The handoff from contentvalidR" (#85);
- Krippendorff (2011) linked to the Annenberg School copy (#86);
- the nomologR reader recorded as tested against 0.6.0 through 0.10.0 (#87).

No computed value changes: 25 analyses across every workflow return the
same values as v0.10.0, and no function, argument, or handoff field
changed. Released on GitHub and R-universe; CRAN keeps 0.4.0 until the
joint 1.0.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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