Skip to contents

Tidy an ordered / inflated ordered fit (broom method)

Usage

# S3 method for class 'iord'
tidy(x, conf.int = FALSE, conf.level = 0.95, ...)

Arguments

x

An "iord" object.

conf.int

If TRUE, add conf.low/conf.high (see confint.iord()).

conf.level

Confidence level for the interval.

...

Unused.

Value

A data frame with one row per parameter: term, estimate, std.error, statistic, p.value, and component (one of "outcome", "cutpoint", "inflation", "rho"); inflation terms keep their infl_ prefix so both equations' terms stay distinct in tables.

See also

summary.iord(); modelsummary::modelsummary() consumes these methods, and texreg::screenreg() uses the package's extract() method; both carry the fit's converged/boundary/ill_conditioned flags.

Other broom methods: augment.iord(), glance.iord()

Examples

if (requireNamespace("broom", quietly = TRUE)) {
  data(bp)
  m <- iop(violence ~ loggdppc + disaster | loggdppc + disaster, data = bp, inflate = "bottom")
  broom::tidy(m, conf.int = TRUE)
  broom::glance(m)
  head(broom::augment(m))
}
#> The inflation equation contains no covariate that is excluded from the outcome equation; the split is then identified by functional form alone. An exclusion restriction is advisable.
#>   violence loggdppc disaster .fitted .prob_none .prob_repression
#> 1     none 9.739502        1    none  0.9846948      0.010279283
#> 2     none 9.773749        4    none  0.9888017      0.005261677
#> 3     none 9.818636        1    none  0.9899915      0.006719807
#> 4     none 9.841048        0    none  0.9915690      0.006117579
#> 5     none 9.829700        4    none  0.9920254      0.003745467
#> 6     none 9.844563        1    none  0.9913498      0.005807242
#>   .prob_civil war    .regime
#> 1     0.005025901 0.03585879
#> 2     0.005936601 0.01540267
#> 3     0.003288656 0.02342862
#> 4     0.002313376 0.02571743
#> 5     0.004229127 0.01096529
#> 6     0.002842929 0.02024325