tidy.iv_factorial {factiv}

Tidy an iv_factorial object

Description

Tidy summarizes information about the components of a model.

Usage

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

Arguments

x

An iv_factorial object produced by a call to iv_factorial()

conf.int

Logical indicating whether or not to include a confidence interval in the tidied output. Defaults to FALSE

conf.level

The confidence level to use for the confidence interval if conf.int = TRUE. Must be strictly greater than 0 and less than 1. Defaults to 0.95, which corresponds to a 95 percent confidence interval.

...

Additional arguments. Not used. Needed to match generic signature only.

Value

A tibble::tibble() with columns:

term

The name of the effect term.

estimand

Which complier effect being estimated.

estimate

The estimated value of the effect.

std.error

The estimated standard error of the effect.

conf.low

Lower bound of the confidence interval for the estimate.

conf.high

Upper bound of the confidence interval for the estimate.

Author(s)

Matt Blackwell