Assert that a link table is the complete population register

A declarative marker for share_weights()'s multiplicity argument. It states that links holds every link in the source population, not only the links of the sampled units, and so authorizes samplyr to count it.

Usage

complete_links()

Value

complete_links() is only meaningful inside share_weights(multiplicity = ) or weighted_links(total = ), and otherwise throws an error.

Details

It makes the same assertion inside weighted_links()'s total argument, where what is totalled is the link importances rather than the links.

Named for the assertion rather than for the counting it triggers, because the assertion is what a reader has to check.

See also

Other weight sharing: extend_links(), share_weights(), weighted_links()

Examples

# Used inside share_weights():
# share_weights(sample, targets, links, by, to, within = hh,
#               multiplicity = complete_links())