-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Clarification on use of weight
argument in as_epidist_marginal_model
#512
Comments
I think for the docs rather than only refer to "weighting" I might mention that this would usually be counts of a particular linelist item (i.e. connecting it up to the data rather than abstractly it's a weighted likelihood -- I'm unsure under what circumstance someone would be weighting in a way unconnected to counts of an observation). |
I agree the documentation isn't super clear, but I think it can be polished up with some edits to the details, and an example. I don't know that a full vignette is needed. |
Agree that a full vignette is not needed for this alone. That said, I do think we should have a vignette / paper about the marginal model (and its differences as compared with the latent model) and it'd naturally be included there about how to use this argument. |
I'm going to take a stab at a good-enough fix now. |
See the updated documentation on |
Could be useful to include the description here which I think has the context? |
I think that probably requires it own issue for more structure in the pkgdown yaml which might help |
The description is:
Maybe this helps a bit. Feels like you would want to directly say the argument |
PR #509 adds support for users providing a column which contains counts / weights. Docs are:
Compatible with
epidist_linelist_data
(which doesn't naturally support weighted linelist / aggregate, hence I suppose #508).Some notes:
So I guess scope of this issue could add docs to note that the marginal model will perform further aggregation if it is possible to given the formula etc. that you specify. Or that could be best left to longer form vignette.
The text was updated successfully, but these errors were encountered: