estimate-methods: Methods for causal estimand results.

In funcml: Functional Machine Learning Framework

Methods for causal estimand results.

Description

These methods provide the standard print(), summary(), and plot() interfaces for funcml_estimand objects.

Usage

## S3 method for class 'funcml_estimand'
print(x, ...)

## S3 method for class 'funcml_estimand'
summary(object, ...)

## S3 method for class 'funcml_estimand'
plot(x, style = c("outcomes", "effects"), bins = 24, alpha = 0.45, ...)

Arguments

x	A funcml_estimand object.
...	Additional arguments passed to the underlying method.
object	A funcml_estimand object.
style	Plot style. "outcomes" shows the model-implied potential outcome distributions under treatment and control. "effects" shows the existing histogram of estimated unit-level effects.
bins	Number of bins used when style = "effects".
alpha	Fill opacity used when style = "outcomes".

Value

print() and summary() return the input object or summary table invisibly. plot() returns a ggplot2 object.

Examples

causal_data <- mtcars
causal_data$am <- factor(causal_data$am, labels = c("auto", "manual"))
ate <- estimate(
  data = causal_data,
  formula = mpg ~ am + wt + hp,
  model = "glm",
  treatment = "am",
  estimand = "ATE"
)
print(ate)
summary(ate)
plot(ate)

funcml documentation built on Aug. 22, 2026, 5:08 p.m.