Skip to content

docs+test: NEWS.md, R-compatibility notes, and R-reference value tests#20

Merged
ismayc merged 3 commits into
mainfrom
docs/news-and-rcompat
Jun 20, 2026
Merged

docs+test: NEWS.md, R-compatibility notes, and R-reference value tests#20
ismayc merged 3 commits into
mainfrom
docs/news-and-rcompat

Conversation

@ismayc

@ismayc ismayc commented Jun 20, 2026

Copy link
Copy Markdown
Member

Addresses three cross-cutting requests.

  1. NEWS.md — a single 0.1.0 section summarizing the current state (inference grammar, theory wrappers, regression/summary helpers, dual-engine plotting, 58 datasets, tooling). Ready to split into 0.1.1/0.2.0 later.
  2. doc/r-compatibility.md — documents the deliberate choices made to match R results that differ from "typical" Python: pop_sd ddof=0, the regression-summary mse denominator, prop_test's chi-square + Yates + Wilson-score CI, the get_p_value two-sided convention, one-sided F/Chisq, UTC datetimes, the derived early_january_2023_weather, plotly as the default engine, get_correlation's na_rm default, and more. Added to the docs nav.
  3. tests/test_r_reference.py — cross-package validation asserting the Python output equals R's exact values on a fixed dataset (get_regression_table/get_regression_summaries/get_correlation/pop_sd/t_test). Values were generated by the R moderndive/infer packages and baked in (CI has no R). New-argument R validations (correlation methods, prop_test vs prop.test, GOF vs scipy) already live alongside their features in feat: moderndive R argument parity (correlation methods, newdata, …) #18/feat: infer R argument parity (med, prop_test options, weighted sampling, …) #19.

279 tests, 100% coverage, ruff clean, docs build warning-free under -W.

Merge note: independent of #18/#19 except it does not touch CHANGELOG.md, so no conflict there.

🤖 Generated with Claude Code

ismayc and others added 3 commits June 20, 2026 12:13
- NEWS.md summarizing the current state under 0.1.0.
- doc/r-compatibility.md documenting the deliberate choices made to match R
  results that differ from "typical" Python (pop_sd ddof=0, regression-summary
  mse denominator, prop_test chi-square+Yates+Wilson CI, get_p_value two-sided
  convention, UTC datetimes, derived early_january_2023_weather, plotly default,
  correlation na_rm default, etc.).
- tests/test_r_reference.py: cross-package checks asserting the Python results
  equal R's exact values on a fixed dataset (get_regression_table/summaries,
  get_correlation, pop_sd, t_test). New-argument R validations live with their
  feature tests (#18/#19).

279 tests, 100% coverage, ruff clean, docs build -W clean.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017CTL1QSTg1DmDUpqYuPEog
# Conflicts:
#	doc/_build/html/.doctrees/api.doctree
#	doc/_build/html/.doctrees/environment.pickle
#	doc/_build/html/.doctrees/getting-started.doctree
#	doc/_build/html/.doctrees/guides/confidence-intervals.doctree
#	doc/_build/html/.doctrees/guides/hypothesis-testing.doctree
#	doc/_build/html/.doctrees/guides/plotting.doctree
#	doc/_build/html/.doctrees/guides/regression.doctree
#	doc/_build/html/.doctrees/guides/theory-based.doctree
#	doc/_build/html/.doctrees/index.doctree
#	doc/_build/html/objects.inv
#	doc/_build/html/searchindex.js
#	doc/_build/jupyter_execute/datasets.ipynb
#	doc/_build/jupyter_execute/getting-started.ipynb
#	doc/_build/jupyter_execute/guides/confidence-intervals.ipynb
#	doc/_build/jupyter_execute/guides/hypothesis-testing.ipynb
#	doc/_build/jupyter_execute/guides/messages.ipynb
#	doc/_build/jupyter_execute/guides/plotting.ipynb
#	doc/_build/jupyter_execute/guides/regression.ipynb
#	doc/_build/jupyter_execute/guides/sampling.ipynb
#	doc/_build/jupyter_execute/guides/theory-based.ipynb
#	doc/_build/jupyter_execute/index.ipynb
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017CTL1QSTg1DmDUpqYuPEog
@ismayc ismayc merged commit a50f708 into main Jun 20, 2026
8 checks passed
@ismayc ismayc deleted the docs/news-and-rcompat branch June 20, 2026 22:21
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