Panel / longitudinal HTML report

Builds an HTML report by ADDING the panel cards to the standard report. When a longitudinal weight is given, it renders the full report_weighting() page for that weight (cascade, weight distribution, deff, ...) and injects a "Panel / longitudinal" section with the rotation structure (panel_design()), the coordinated net-change variance (change_estimate()), the attrition/retention summary, and the gross flows (transition_matrix() / boot_transition()). Without a longitudinal weight it writes a small standalone page with those cards. Any argument may be NULL; its card is skipped.

Usage

report_panel(
  design = NULL,
  change = NULL,
  longitudinal = NULL,
  transition = NULL,
  coordinated = NULL,
  estimates = NULL,
  variance = NULL,
  file = NULL,
  open = TRUE,
  lang = c("en", "es")
)

Arguments

design: a wf_panel_design from panel_design().
change: a weightflow_change from change_estimate() / change_mean().
longitudinal: a prepped longitudinal weighting_spec; when given, the report is the full weighting report of that weight with the panel section added.
transition: a weightflow_transition / _boot from the flow functions.
coordinated: the coordinated wave_bootstrap() / wave_jackknife() object behind change, so the report shows a "Replication-based variance estimation" card stating the coordinated method, replicates, strata, PSUs, recipe-aware setting and seed.
estimates: results of the estimation grammar: a weightflow_estimation_result from collect_estimates(), an uncollected step_estimate() pipeline (collected here), or a named list of either – the names become the card titles. Each becomes a results block with the levels behind a change, its coordinated standard error and confidence interval, a dot-and-whisker chart across the step_domain() cells, and the subpopulation any step_filter() restricted it to.
variance: the longitudinal-weight bootstrap_weights() / jackknife object, so the base report shows the variance/replication card (deff, method, replicates) for the longitudinal weight instead of "replicate weights not created". The coordinated CHANGE variance is shown by the change card.
file: output path; a temporary .html if NULL.
open: open the file in a browser.
lang: "en" (default) or "es".

Value

the path to the written HTML file, invisibly.

Usage

Arguments

Value

See also