Skip to content

Standardize reproduction number notation to $\mathcal{R}(t)$ - #681

Merged
dylanhmorris merged 3 commits into
mainfrom
copilot/standardize-reproduction-number-format
Feb 6, 2026
Merged

dylanhmorris merged 3 commits into
mainfrom
copilot/standardize-reproduction-number-format

Conversation

Copilot AI commented Feb 6, 2026 •

Copy link
Copy Markdown
Contributor

Standardizes all mathematical notation for the time-varying reproduction number to $\mathcal{R}(t)$. This disambiguates the reproduction number from the recovered compartment (R) in SIR-family models and emphasizes the time-dependent function over subscript notation.

Changes

Before:

$R_t$ or $R(t)$

After:

$\mathcal{R}(t)$, $\mathcal{R}_k(t)$, $\mathcal{R}_{\text{baseline}}(t)$

Files Updated

  • README.md: Core equation and description
  • pyrenew/latent/infections.py: Docstring equations
  • docs/tutorials/building_multisignal_models.qmd: 9 instances
  • docs/tutorials/latent_hierarchical_infections.qmd: 6 instances including hierarchical forms
  • equations.md: Mermaid diagram labels

All changes are documentation-only (docstrings, markdown, Quarto tutorials).

Original prompt

This section details on the original issue you should resolve

<issue_title>Standardize on \mathcal{R}(t) for the time-varying reproduction number in the docs</issue_title>
<issue_description>- Propose $\mathcal{R}$ over $R$ to disambiguate the reproduction number from the recovered compartment in SIR-family models.

  • Propose $\mathcal{R}(t)$ over $\mathcal{R}_t$ to reflect that the reproduction number is a function of time is a latent quantity, not a datapoint.

I think this should wait for #650 to land. After that, it might be a good task for a coding agent.</issue_description>

<agent_instructions>Please standardize all docstrings and documentation so that the time-varying reproduction number R(t) is rendered in TeX-style math as $\mathcal{R}(t)$ rather than $R(t)$, $R_t$, or $\mathcal{R}_t$.</agent_instructions>

Comments on the Issue (you are @copilot in this section)

@dylanhmorris Note that GH renders `$\mathcal{R}$` in markdown identically to `$R$` (at least for me), but they render differently in our docs (which use [katex](https://katex.org/)).

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits February 6, 2026 17:19
Co-authored-by: dylanhmorris <8032117+dylanhmorris@users.noreply.github.com>
Co-authored-by: dylanhmorris <8032117+dylanhmorris@users.noreply.github.com>
Copilot AI changed the title [WIP] Standardize on \mathcal{R}(t) for reproduction number in docs Standardize reproduction number notation to $\mathcal{R}(t)$ Feb 6, 2026
Copilot AI requested a review from dylanhmorris February 6, 2026 17:23
@dylanhmorris
dylanhmorris marked this pull request as ready for review February 6, 2026 17:30
@codecov

codecov Bot commented Feb 6, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.58%. Comparing base (265b2bf) to head (2b1be52).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #681   +/-   ##
=======================================
  Coverage   97.58%   97.58%           
=======================================
  Files          55       55           
  Lines        1697     1697           
=======================================
  Hits         1656     1656           
  Misses         41       41           
Flag Coverage Δ
unittests 97.58% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions

github-actions Bot commented Feb 6, 2026

Copy link
Copy Markdown

Thank you for your contribution @Copilot 🚀! Your github-pages is ready for download 👉 here 👈!
(The artifact expires on 2026-02-13T17:40:58Z. You can re-generate it by re-running the workflow here.)

@dylanhmorris dylanhmorris left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Diffs look correct and so do the rendered docs.

@dylanhmorris
dylanhmorris merged commit 27b2964 into main Feb 6, 2026
8 checks passed
@dylanhmorris
dylanhmorris deleted the copilot/standardize-reproduction-number-format branch February 6, 2026 17:55
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.

Standardize on \mathcal{R}(t) for the time-varying reproduction number in the docs

2 participants