Extract sensitivity results as a tidy data frame

Returns the results table of a regsensitivity object as a plain data.frame, with the sensitivity parameters and the bounds (or the breakdown frontier) in columns.

Usage

# S3 method for class 'regsensitivity'
as.data.frame(
  x,
  row.names = NULL,
  optional = FALSE,
  ...,
  digits = NULL,
  finite_only = FALSE
)

Arguments

x

A regsensitivity object, from regsen_bounds() or regsen_breakdown().

row.names, optional

Ignored, present for S3 compatibility with base::as.data.frame().

...

Ignored.

digits

Optional number of significant digits to round numeric columns to. NULL (default) leaves the values at full precision, which is what you want when the result feeds further computation.

finite_only

Logical. If TRUE, drop rows where every bound is non-finite. Defaults to FALSE so that the unbounded region of the sweep stays visible.

Value

A data.frame.

Details

This is the recommended entry point for producing tables. Because the return value is an ordinary data frame it can be handed to whichever table package you already use – knitr::kable(), kableExtra, gt, modelsummary, huxtable, tinytable or xtable – rather than committing the package to one of them. regsen_table() wraps the common case.

Examples

# \donttest{
data(bfg2020)
res <- regsen_bounds(
    avgrep2000to2016 ~ tye_tfe890_500kNI_100_l6 + log_area_2010 + lat + lon,
    data = bfg2020, compare = c("log_area_2010", "lat", "lon"), cbar = 0.1
)
head(as.data.frame(res))
#>       rxbar rybar cbar       bmin     bmax
#> 1 0.0000000   Inf  0.1  1.3854162 1.385416
#> 2 0.2531195   Inf  0.1  0.5047744 2.266058
#> 3 0.5062390   Inf  0.1 -0.4434758 3.214308
#> 4 0.7593584   Inf  0.1 -1.4932901 4.264122
#> 5 1.0124779   Inf  0.1 -2.6971380 5.467970
#> 6 1.2655974   Inf  0.1 -4.1441420 6.914974
# }