API ReferenceEntry

outcome_stats

outcome_stats

Reference details for outcome_stats in causalis.shared.

outcome_stats

Outcome shared grouped by treatment for CausalData.

Functions
  • outcome_stats – Comprehensive outcome shared grouped by treatment.
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
Returns
  • 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:

code.pycon