Skip to content
Submodule
causalis.shared.outcome_stats

outcome_stats

Submodule causalis.shared.outcome_stats with no child pages and 1 documented members.

Functions

Jump directly into the documented functions for this page.

1 items
function
causalis.shared.outcome_stats.outcome_stats

outcome_stats

Comprehensive outcome shared grouped by treatment.

Returns a DataFrame with detailed outcome shared for each treatment group, including count, mean, std, min, various percentiles, and max. This function provides comprehensive outcome analysis and returns data_contracts in a clean DataFrame format suitable for reporting.

Parameters

dataCausalData or MultiCausalData

The causal dataset containing treatment and outcome variables.

Returns

pd.DataFrame

DataFrame with treatment groups as index and the following columns: - count: number of observations in each group - mean: average outcome value - std: standard deviation of outcome - min: minimum outcome value - p10: 10th percentile - p25: 25th percentile (Q1) - median: 50th percentile (median) - p75: 75th percentile (Q3) - p90: 90th percentile - max: maximum outcome value

Examples

Canonical target

causalis.shared.outcome_stats.outcome_stats

Sections

ParametersReturnsExamples
Link to this symbol