Compute the proportion of values above term-specific thresholds within grouped simulation results
Source:R/model_evaluation.R
eval_greater_than.Rd
Computes the proportion of x
values exceeding term-specific thresholds within each group,
typically inside evaluate_model_results()
for simulation evaluation pipelines.
Arguments
- x
A numeric vector of estimates or statistics.
- term
A named numeric vector providing the threshold for each term. For example,
c("(Intercept)" = 0, x = 2)
. IfNULL
(default), threshold is assumed to be zero.- na.rm
Logical; whether to remove missing values when computing the proportion. Defaults to
FALSE
.
Value
A numeric scalar representing the proportion of x
exceeding the term-specific threshold 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)
#> Error in library(dplyr): there is no package called ‘dplyr’
library(purrr)
library(broom.mixed)
#> Error in library(broom.mixed): there is no package called ‘broom.mixed’
sim_models <- tibble(
id = 1:50,
model = map(1:50, ~ lm(mpg ~ wt, data = mtcars))
) |>
extract_model_results()
#> Error in loadNamespace(x): there is no package called ‘tidyr’
sim_models |>
filter(term == "wt") |>
evaluate_model_results(
prop_above_0 = eval_greater_than(
estimate,
term = c("wt" = 0)
)
)
#> Error in loadNamespace(x): there is no package called ‘dplyr’