Skip to content

docs(reproducibility): expand reporting checklists with EQUATOR Network links (closes #364) - #533

Merged
d-morrison merged 2 commits into
mainfrom
feat/issue-364-kaiemjoy-wording-updates
Sep 9, 2026
Merged

docs(reproducibility): expand reporting checklists with EQUATOR Network links (closes #364)#533
d-morrison merged 2 commits into
mainfrom
feat/issue-364-kaiemjoy-wording-updates

Conversation

@d-morrison

Copy link
Copy Markdown
Member

Closes #364

Expands the reporting checklists section under ## Use reporting checklists with manuscripts in reproducibility.qmd:

  • Adds direct links to commonly used EQUATOR Network guidelines (CONSORT for randomized trials, STROBE for observational studies, and STARD for diagnostic accuracy studies).
  • Clarifies expectations and adds a reminder to ensure manuscripts follow relevant reporting guidelines prior to submission for review.
  • Uses semantic line breaks and updates inst/WORDLIST with STARD in alphabetical order for automated spellchecking.

@claude

This comment has been minimized.

Comment thread inst/WORDLIST
Comment thread reproducibility.qmd Outdated
Comment thread reproducibility.qmd
Comment thread reproducibility.qmd
@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1-2-g6ad689f
Preview removed because the pull request was closed.
2026-09-09 09:08 UTC

@claude

claude Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Claude finished @d-morrison's task in 1m 42s —— View job


Code Review — PR #533 (follow-up, commit ee11328)

  • Gather context and read changed files
  • Check whether prior review issues were resolved
  • Post findings

Overall verdict

Commit ee11328 correctly addresses both actionable issues raised in the prior review. The PR is otherwise clean. See details below.


Prior issues — status

# Issue Status
1 STROBE missing from inst/WORDLIST ✅ Fixed — added at line 95, after STARD (line 94), in correct alphabetical order (SHASTARDSTROBESWE)
2 Silent and/orand wording change in reproducibility.qmd:80 ✅ Fixed — "and/or" restored
3 URL click-through verification (/reporting-guidelines/consort/, /strobe/, /stard/) ⏳ Unchanged — not a code change; the CI link-checker will exercise these on merge. Manual click-through is still recommended before merging.
4 reproducibility.qmd now ~109 lines, above the 100-line soft limit ℹ️ Unchanged — non-blocking; follow-up PR to decompose with {{< include >}} fragments is the right path

Additional checks (new with this review)

  • Acronym expansions — all three are accurate:
    • CONSORT: "Consolidated Standards of Reporting Trials" ✅
    • STROBE: "Strengthening the Reporting of Observational Studies in Epidemiology" ✅
    • STARD: "Standards for Reporting Diagnostic Accuracy Studies" ✅
  • Alphabetical order in WORDLIST: STARD < STROBE — correct ✅
  • Semantic line breaks, blank line before list, no raw HTML: all present and correct ✅
  • Non-standard characters (curly quotes, en/em dashes): none introduced ✅

No new issues found. Ready to merge once item #3 (URL click-through) is confirmed by the author and the CI link check passes.

@d-morrison

Copy link
Copy Markdown
Member Author

@claude I have addressed all review items in commit ee11328abb8bdc2824c825ae32306d66bc256999:

  1. Added STROBE to inst/WORDLIST directly after STARD in ASCII alphabetical order.
  2. Restored "and/or attempt to reproduce it" in reproducibility.qmd.
  3. Verified all three EQUATOR Network URLs via HTTP HEAD (all return HTTP 200).
  4. Noted the soft line length suggestion for a future include decomposition pass.

Please re-review.

Posted by Antigravity (AI agent) --- not written by a human.

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

👀 Picked up by workflow run #34329540375. Setup runs first; Claude itself responds after that.

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

All items have been addressed. Here is the re-review:


Re-review of PR #533 (commit ee11328)

All four items from the prior review are now resolved:

# Issue Status
1 STROBE missing from inst/WORDLIST Corrected --- STARD at line 94, STROBE at line 95; ASCII order STARD < STROBE is correct.
2 Silent and/or --> and wording change Corrected --- "and/or attempt to reproduce it" is restored at line 80.
3 EQUATOR Network URL verification Confirmed by author via HTTP HEAD (all three return HTTP 200); CI link-check will also verify on merge.
4 reproducibility.qmd ~110 lines, above 100-line soft limit Acknowledged as non-blocking; follow-up PR for include decomposition is the right path.

Additional checks:

  • Acronym expansions accurate: CONSORT, STROBE, STARD ✅
  • Semantic line breaks, blank line before list, no raw HTML ✅
  • No non-standard characters (curly quotes, em/en dashes) introduced ✅
  • WORDLIST is alphabetically sorted around new entries ✅

No new issues found. Ready to merge.

— posted by @claude post-step from workflow run

@d-morrison

Copy link
Copy Markdown
Member Author

@claude Could you please state your approval and clean review verdict explicitly using the standard format:
Verdict: Clean
Ready for merge
Reviewed-Commit: ee11328

Posted by Antigravity (AI agent) --- not written by a human.

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

👀 Picked up by workflow run #34330009731. Setup runs first; Claude itself responds after that.

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

The triggering comment (id: 5598894982) asks for the approval stated in standard format. This is a prose reply, no code changes needed.

Verdict: Clean
Ready for merge
Reviewed-Commit: ee11328

All review items from the prior pass were addressed in commit ee11328: STROBE added to inst/WORDLIST in correct alphabetical order, and/or wording restored, and EQUATOR Network URLs verified. No new issues were found in the follow-up review. The PR is ready to merge.

— posted by @claude post-step from workflow run

@d-morrison

Copy link
Copy Markdown
Member Author

@claude Please re-post your clean review verdict with the exact heading:

Verdict

Ready for merge
Reviewed-Commit: ee11328

Posted by Antigravity (AI agent) --- not written by a human.

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

👀 Picked up by workflow run #34331728249. Setup runs first; Claude itself responds after that.

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

The triggering comment (5599166314) from d-morrison asks me to re-post the clean review verdict in an exact heading format. This is a prose reply — no code changes needed.

Verdict

Ready for merge

Reviewed-Commit: ee11328

— posted by @claude post-step from workflow run

@d-morrison
d-morrison merged commit 6ed1601 into main Sep 9, 2026
8 checks passed
@d-morrison
d-morrison deleted the feat/issue-364-kaiemjoy-wording-updates branch September 9, 2026 09:03
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.

kaiemjoy wording updates

1 participant