R/result_bounds.R

In wavecov: Overlap-Aware Workforce Wave Comparisons

#' wavecov bounded-result object

#'

#' Internal constructor and methods for Cauchy-based bounds on the variance

#' of the change in means.

#'

#' @param summary Minimal summary list (typically from summarize_panel()).

#' @param bounds List returned by variance_bounds().

#' @param level Confidence level to use when converting SE bounds to an

#'   interval envelope via confint().

#'

#' @return An object of class "wavecov_bounds_result".

#' @keywords internal
new_wavecov_bounds_result <- function(summary,
                                      bounds,
                                      level) {
  Delta_hat <- summary$ybar1 - summary$ybar0
  
  structure(
    list(
      estimate  = Delta_hat,
      se_lower  = bounds$se_lower,
      se_upper  = bounds$se_upper,
      var_lower = bounds$var_lower,
      var_upper = bounds$var_upper,
      level     = level,
      N0        = summary$N0,
      N1        = summary$N1,
      nS        = summary$nS,
      overlap   = summary$nS / base::min(summary$N0, summary$N1),
      cov_sign  = bounds$cov_sign,
      overlap_mode = bounds$overlap_mode,
      method    = "bounds"
    ),
    class = "wavecov_bounds_result"
  )
}