Repository navigation
Documentation request for X² test #302
Description
Description
A proper explanation/tutorial for handling chi-squared-tests is missing. There seems to be at least three versions of the Chi-Square test existing:
- distribution test
- independence test
- homogenity test
A description is needed that introduces the core concept of the X²-distributed test statistic and how to apply the tests.
@omaus started to look at the test in #181 but I think there is some sort of proper description missing for which test requires which parameters etc.
Thanks for pointing this out @matthewcrews 🚀
Activity
[-]Documentation request[/-][+]Documentation request for X² test[/+]github-actions commentedon Apr 1, 2026
🤖 This is an automated response from Repo Assist.
Related to the documentation gap here: PR #362 has just been opened which fixes a concrete bug that was contributing to confusion around the χ² API —
ChiSquareTest.pearsonChiSquared(table: ContingencyTable<_,_>)was a stub that always returned42., making the independence test path completely unusable.Once that PR is merged, the three χ² test variants available in
FSharp.Statswill all be functional:ChiSquareTest.pearsonChiSquaredTestChiSquareTest.pearsonChiSquared(table: ContingencyTable<_,_>)ChiSquareTest.pearsonChiSquared(table: Contingency2x2)Linking also PR #181 which adds the Cochran–Mantel–Haenszel test for stratified 2×2 tables — that PR may be worth reviewing alongside the documentation work.
A useful addition to the docs would be a worked example showing which function to call for each scenario (goodness-of-fit vs. independence vs. homogeneity), with a short note on degrees of freedom.