riskRegression: summary.ate – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

riskRegression

summary.ate

Summary Average Treatment Effects

Description

Summary average treatment effects.

Usage

## S3 method for class 'ate'
summary(
  object,
  estimator = object$estimator[1],
  short = FALSE,
  type = c("meanRisk", "diffRisk"),
  se = FALSE,
  quantile = FALSE,
  estimate.boot = TRUE,
  digits = 3,
  ...
)

Arguments

`object`	object obtained with function `ate`
`estimator`	[character] The type of estimator relative to which the estimates should be displayed.
`short`	[logical] If `TRUE`, only displays the estimated risks.
`type`	[character vector] what to displayed. Can be `"meanRisk"` to display the risks specific to each treatment group, `"diffRisk"` to display the difference in risks between treatment groups, or `"ratioRisk"` to display the ratio of risks between treatment groups,.
`se`	[logical] should the standard error of the risks be displayed?
`quantile`	[logical] should the quantile of the confidence bands be displayed?
`estimate.boot`	[logical] should the average estimate on the bootstrap samples be displayed?
`digits`	[integer, >0] Number of digits.
`...`	passed to confint

Details

to display confidence intervals/bands and p.value, the confint method needs to be applied on the object.