Repository navigation
Open the README with the problem, not the description - #325
Merged
Merged
Conversation
The README began 'microdf provides MicroDataFrame and MicroSeries classes that extend pandas functionality', which tells a reader what the package contains but not why they would want it. A JOSS reviewer is asked whether the software has a clear statement of need. States the two problems instead: that the weighted estimators are not the obvious ones and each involves a documented choice, and that weights have to survive merges, filters and grouping before any estimator runs, failing silently when they do not.
Merged
juaristi22
approved these changes
Sep 18, 2026
juaristi22
left a comment
Collaborator
There was a problem hiding this comment.
Checked the two convention claims against the source. var uses sum(w) - ddof as the denominator and matches np.var on the replicated sample with integer weights. quantile is the inverse CDF, the smallest value where the cumulative weight share reaches q, which is what the docstring cites survey::svyquantile for. Both hold numerically.
The README is also the PyPI long description, so this shows up there at the next release. The fragment is .changed, so a patch bump. Approving.
30 of 31 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README opened with:
That tells a reader what the package contains, not why they would want it. The JOSS review checklist asks directly whether the software has a clear statement of need, and this is the first thing a reviewer reads.
Replaces the
## Overviewparagraph with a## Why this existssection stating the two problems the package actually solves, which are the same two the paper leads on:microdfmakes each choice once, documents it and tests it.Nothing else in the README changes: the features list, installation and usage sections are untouched.