# `causalis.shared.outcome_stats`

Outcome shared grouped by treatment for CausalData.

## Module Contents

### Functions

`outcome_stats` | Comprehensive outcome shared grouped by treatment.

### API

causalis.shared.outcome_stats.outcome_stats(data: causalis.dgp.causaldata.CausalData | causalis.dgp.multicausaldata.MultiCausalData) → pandas.DataFrame

  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

  data : CausalData 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

  > > > stats = outcome_stats(causal_data) print(stats) treatment count mean std min p10 p25 median p75 p90 max 0 0 3000 5.123456 2.345678 0.123456 2.345678 3.456789 5.123456 6.789012 7.890123 9.876543 1 1 2000 6.789012 2.456789 0.234567 3.456789 4.567890 6.789012 8.901234 9.012345 10.987654