Test whether an object is a vpc_stats container

Predicate that returns TRUE if x carries the "vpc_stats" class — i.e., it is the container returned by df_vpcstats() (also accepted by plot_vpc_cont() on the precomputed-stats fast path).

Usage

is_vpc_stats(x, strict = FALSE)

Arguments

x

Object to test.

strict

Logical. When TRUE, additionally runs validate_vpc_stats() and returns FALSE on validation failure. Default FALSE (class-tag check only, cheap).

Value

Logical scalar.

See also

Other vpc: df_vpcstats(), is_pmx_vpc_plot(), plot_build_vpc(), plot_vpc_cens(), plot_vpc_cont(), plot_vpc_legend(), plot_vpc_shown(), plot_vpc_theme()

Examples

model <- model_mread_load(model = "pkmodel")
#> Loading model from cache.
simout <- df_mrgsim_replicate(data = data_sad, model = model, replicates = 5,
                              dv_var = ODV)
out <- df_vpcstats(simout)
#> Warning: Multiple unique values of `CMT` detected in `data` after filtering to `EVID == 0`: 2, 3.
#> ℹ Functions assume a single observation type per call.
#> ℹ Pre-filter to a single observation compartment (e.g., `dplyr::filter(data, CMT == <n>)`) before passing to this function.
is_vpc_stats(out)        # TRUE
#> [1] TRUE
is_vpc_stats(out$stats)  # FALSE — that's the inner data.frame
#> [1] FALSE