Validate a named list of adjusted flow outputs — validate_flow

These functions apply the corresponding single-output validation function to every element of a named list. They are intended for method-comparison workflows where several adjusted outputs are evaluated against the same benchmark OD table.

Usage

validate_flow_overall_methods(
  adjusted_outputs,
  benchmark_od_df,
  comparisons = "all",
  drop_zeros = FALSE,
  return_joined = FALSE,
  ...
)

validate_flow_residual_methods(
  adjusted_outputs,
  benchmark_od_df,
  top_n = 10L,
  ...
)

validate_flow_distribution_methods(
  adjusted_outputs,
  benchmark_od_df,
  comparisons = "all",
  weight_by = "benchmark_origin_total",
  return_origin_level = TRUE,
  return_od_level = FALSE,
  ...
)

validate_flow_residual_structure_methods(
  adjusted_outputs,
  benchmark_od_df,
  methods = names(adjusted_outputs),
  comparison = "adjusted_vs_benchmark",
  ...
)

Arguments

adjusted_outputs: Named list of adjusted-flow data frames. Each data frame is passed to the corresponding single-output validator.
benchmark_od_df: Benchmark OD data frame.
comparisons: Flow comparison(s) to compute. Defaults follow the vignette comparison workflow.
drop_zeros: Passed to validate_flow_overall().
return_joined: Passed to validate_flow_overall().
...: Additional arguments passed to the corresponding single-output validator. Do not pass method_name; it is derived from the list names.
top_n: Passed to validate_flow_residuals().
weight_by, return_origin_level, return_od_level: Passed to validate_flow_distribution().
methods: Optional method IDs to include for residual-structure validation. Default uses all elements in adjusted_outputs.

Value

A named list of validation results.