get_confint: Get the tidy variance summary and confidence intervals for...

Description Usage Arguments Details Value Examples

View source: R/ols-confint.R

Description

Get the tidy variance summary and confidence intervals from a fitted OLS maars_lm, lm class object

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
get_confint(
  mod_fit,
  parm = NULL,
  level = 0.95,
  sand = NULL,
  boot_emp = NULL,
  boot_sub = NULL,
  boot_mul = NULL,
  boot_res = NULL,
  well_specified = NULL
)

Arguments

mod_fit

(maars_lm, lm) A fitted OLS maars_lm, lm class object

parm

(NULL) : a specification of which parameters are to be given confidence intervals, either a vector of numbers or a vector of names. If missing, all parameters are considered. Currently only allowed value is NULL.

level

(double) : numeric value between 0 and 1 indicating the confidence level (e.g., 0.95)

sand

(logical) : TRUE if sandwich estimator output is required, FALSE to exclude this output from the request

boot_emp

(logical) : TRUE if empirical bootstrap standard error output is required, FALSE to exclude this output from the request

boot_sub

(logical) : TRUE if subsampling standard error output is required, FALSE to exclude this output from the request

boot_mul

(logical) : TRUE if multiplier bootstrap standard error output is required, FALSE to exclude this output from the request

boot_res

(logical) : TRUE if residual bootstrap standard error output is required, FALSE to exclude this output from the request

well_specified

(logical) : TRUE if lm standard errors (well specified) output is required, FALSE to exclude this output from the request

Details

The function generates the same output as get_boot_summary, but also includes lower and upper confidence intervals for the regression coefficients according to the significance level specified in the "level" argument.

Value

(tibble) : Combined standard error and confidence intervals summary from a fitted OLS maars_lm, lm class object

Examples

1
2
3
4
## Not run: 
# TODO: Add here

## End(Not run)

shamindras/maar documentation built on Sept. 19, 2021, 10:21 p.m.