Declare that overlap values are inclusion probabilities

A declarative marker for stack_frames()'s overlaps argument. It names, for every frame, the column holding the probability a unit would have been selected from that frame, including the frames it was not selected from.

The scale is declared rather than inferred from the values. survey::multiframe() infers it, reading a matrix as weights when no non-zero entry in some frame falls below one, which is reachable whenever a frame is a census or its overlapping units are certainties. samplyr produces those routinely, so the value that decides the reading is a value this package generates on purpose.

Usage

overlap_probabilities(...)

Arguments

...

One named argument per frame, giving the column name as a string: overlap_probabilities(area = "pi_area", list = "pi_list").

Value

An object of class samplyr_overlap_spec, carrying the declared scale and the column mapping, for stack_frames()'s overlaps argument.

See also

Other multiple frames: as.data.frame.frame_stack(), as_svrepdesign.frame_stack(), as_svydesign.frame_stack(), exante_overlaps(), exante_probabilities(), overlap_weights(), stack_frames(), summary.frame_stack()

Examples

overlap_probabilities(area = "pi_area", list = "pi_list")
#> ℹ Overlap probabilities, by frame: pi_area and pi_list