make links to code / paper clearer

[sbfnk]

Summary by CodeRabbit

• Documentation
  • Expanded README with a clearer introductory overview of the package (simulation of infectious disease transmission with contact tracing), acknowledging its origin in a 2020 paper. Added direct links to the companion analysis code and the paper for further reading. Retained the original brief description for continuity. No behavioral or API changes.

[coderabbitai]

Walkthrough

A new descriptive block was added to README.Rmd above the existing package description, noting package purpose, origin in a 2020 paper, and linking to companion analysis code and the paper. No code or functional changes.

Changes

Cohort / File(s)	Summary of Changes
Documentation README.Rmd	Inserted a multi-line introductory description about the package’s purpose, origin (2020 paper), and links to analysis code and the paper; retained original description. No code changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The changeset adds explanatory text and explicit links to the companion analysis code and paper in README.Rmd, and the title "make links to code / paper clearer" succinctly and directly describes that primary documentation change.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

Poem

A nibble of notes in README’s glade,
New lines hop in where context is laid.
Links like clover, tidy and bright,
Paper and code in gentle light.
I twitch my whiskers—docs now sing,
Thump! Another tidy spring. 🐇📜

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f424329 and 7baf822.

📒 Files selected for processing (1)

• README.Rmd (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• README.Rmd

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: pkgdown
• GitHub Check: render-readme

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch sbfnk-patch-1

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

21-22: Confirm intended code link target and tighten wording.

• The link points to cmmid/ringbp, which is the analysis repo for the paper rather than this package; if that’s the intent, consider labeling it “companion analysis code” to avoid confusion with the package code here. (github.com)
• Minor grammar: replace the comma splice with a semicolon.

Apply this diff:

- COVID-19, see the associated [code](https://github.com/cmmid/ringbp) and 
- [paper](https://doi.org/10.1016/S2214-109X(20)30074-7) for more details.
+ COVID-19; see the companion analysis [code](https://github.com/cmmid/ringbp) and
+ [paper](https://doi.org/10.1016/S2214-109X(20)30074-7) for more details.

Optional: link to a tagged release or commit in cmmid/ringbp for reproducibility.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 07c6523 and f424329.

📒 Files selected for processing (1)

• README.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: pkgdown

🔇 Additional comments (1)

README.md (1)

20-22: Clarity improvement looks good.

The added links make the provenance explicit and are helpful to readers. DOI appears correct for Hellewell et al., 2020. (pubmed.ncbi.nlm.nih.gov)