Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Improve weights docstrings #757

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Improve weights docstrings #757

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c03d404
Improve weigths docstrings
nalimilan Jan 18, 2022
538399f
Add mentions about scale-invariance
nalimilan Jan 20, 2022
0350e4e
Update weights.jl
nalimilan Jan 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions src/weights.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,11 @@ end
Construct an `AnalyticWeights` vector with weight values `vs`.
A precomputed sum may be provided as `wsum`.

Analytic weights describe a non-random relative importance (usually between 0 and 1)
for each observation. These weights may also be referred to as reliability weights,
precision weights or inverse variance weights. These are typically used when the observations
being weighted are aggregate values (e.g., averages) with differing variances.
Analytic weights are proportional to the inverse of the variance for each case.
These weights may also be referred to as reliability weights or precision weights.

The scale of analytic weights is significant: for some functions,
multiplying all weights by a constant changes the result.
""" AnalyticWeights

"""
Expand Down Expand Up @@ -136,8 +137,11 @@ end
Construct a `FrequencyWeights` vector with weight values `vs`.
A precomputed sum may be provided as `wsum`.

Frequency weights describe the number of times (or frequency) each observation
Frequency weights represent the number of times (or frequency) each case
nalimilan marked this conversation as resolved.
Show resolved Hide resolved
was observed. These weights may also be referred to as case weights or repeat weights.

The scale of frequency weights is significant: for some functions,
multiplying all weights by a constant changes the result.
""" FrequencyWeights

"""
Expand Down Expand Up @@ -173,9 +177,14 @@ end
Construct a `ProbabilityWeights` vector with weight values `vs`.
A precomputed sum may be provided as `wsum`.

Probability weights represent the inverse of the sampling probability for each observation,
Probability weights represent the inverse of the sampling probability for each case,
providing a correction mechanism for under- or over-sampling certain population groups.
These weights may also be referred to as sampling weights.
These weights may also be referred to as sampling weights or survey weights.

The scale of probability weights is not significant: multiplying all weights
by a constant does not change the result of any weighted functions
(except when explicitly computing the sum of weights). This is because
the sample size is taken to be the number of cases with a non-zero weight.
""" ProbabilityWeights

"""
Expand Down