Compute the proportion of values within term-specific intervals within grouped simulation results
Source:R/model_evaluation.R
eval_between.Rd
Computes the proportion of x
values falling within term-specific intervals within each group,
typically inside evaluate_model_results()
for simulation evaluation pipelines.
Arguments
- x
A numeric vector of estimates or statistics.
- term
A named list of numeric vectors of length 2, giving the lower and upper bounds for each term. For example,
list("(Intercept)" = c(-1, 1), x = c(1, 3))
. IfNULL
(default), the interval is assumed to be[0, 1]
.- na.rm
Logical; whether to remove missing values when computing the proportion. Defaults to
FALSE
.
Value
A numeric scalar representing the proportion of x
within the term-specific interval within the current group.
Details
This function is designed to be used inside dplyr::summarise()
within a grouped
tidyverse pipeline, typically after grouping by term
.
If term
is provided, the current grouping must include a term
variable matching
the names in term
. If a term in the group is not found in the provided term
mapping,
the function will return NA
with a warning.
Examples
library(dplyr)
#>
#> Attaching package: ‘dplyr’
#> The following objects are masked from ‘package:stats’:
#>
#> filter, lag
#> The following objects are masked from ‘package:base’:
#>
#> intersect, setdiff, setequal, union
library(purrr)
library(broom.mixed)
sim_models <- tibble(
id = 1:50,
model = map(1:50, ~ lm(mpg ~ wt, data = mtcars))
) |>
extract_model_results()
sim_models |>
filter(term == "wt") |>
evaluate_model_results(
prop_between = eval_between(
estimate,
term = list("wt" = c(-1, 0))
)
)
#> Error in dplyr::summarise(results, n_models = dplyr::n(), mean_estimate = dplyr::if_else(condition = all(is.na(p.value)), true = NA_real_, false = mean(estimate, na.rm = TRUE)), mean_std.error = dplyr::if_else(condition = all(is.na(p.value)), true = NA_real_, false = mean(std.error, na.rm = TRUE)), power = dplyr::if_else(condition = all(is.na(p.value)), true = NA_real_, false = mean(p.value < alpha, na.rm = TRUE)), !!!summary_exprs, !!!{ if (.summarise_standard_broom) { rlang::exprs(dplyr::across(dplyr::all_of(intersect(broom_cols, names(results))), list(mean = mean, sd = sd), .names = "{fn}_{col}")) } else { rlang::exprs() } }): ℹ In argument: `prop_between = eval_between(estimate, term = list(wt =
#> c(-1, 0)))`.
#> Caused by error in `abort()`:
#> ! could not find function "abort"