The frame digest is a compact, versioned execution manifest
attached to executed samples under metadata$frame_digest: frames,
selection pools, resolved chances, allocation, and the
selected-unit trace. It is a plain list of base-typed records and
data frames whose size scales with selection pools, retained
cluster units, and quantile bins rather than with frame rows.
Cluster stages keep one unit row per cluster for downstream
linkage, so a stage whose clusters are single frame rows grows
with the frame. execute(frame_digest = "none") opts out.
See also
Other extension APIs:
exante_digest(),
get_frame_digest()
Examples
sample <- sampling_design() |>
stratify_by(region) |>
draw(n = 20) |>
execute(bfa_eas, seed = 1)
# frame_summary() is the stable tabular view of the same manifest
frame_summary(sample, detail = "stage")
#> # A tibble: 1 × 12
#> stage unit_level scope chance_kind probabilities storage n_pools N
#> <int> <chr> <chr> <chr> <chr> <chr> <int> <dbl>
#> 1 1 element universe inclusion_proba… exact consta… 13 44570
#> # ℹ 4 more variables: n_target <dbl>, n_expected <dbl>, n_realized <dbl>,
#> # take_rate <dbl>
# get_frame_digest() returns the raw list for extension packages
str(get_frame_digest(sample), max.level = 1)
#> List of 5
#> $ version: int 2
#> $ status : chr "complete"
#> $ privacy:List of 3
#> $ frames :List of 1
#> $ stages :List of 1