solas\_disparity.types.Disparity
================================

.. currentmodule:: solas_disparity.types

.. autoclass:: Disparity

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~Disparity.__init__
      ~Disparity.show
      ~Disparity.to_csv
      ~Disparity.to_excel
      ~Disparity.to_image
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~Disparity.affected_categories
      ~Disparity.affected_categories_by_segment
      ~Disparity.affected_groups
      ~Disparity.affected_groups_by_segment
      ~Disparity.affected_reference
      ~Disparity.affected_reference_by_segment
      ~Disparity.air
      ~Disparity.average_label
      ~Disparity.average_outcome
      ~Disparity.average_prediction
      ~Disparity.average_residual
      ~Disparity.benjamani_hochberg_critical_value
      ~Disparity.categories
      ~Disparity.difference
      ~Disparity.false_discovery_rate
      ~Disparity.false_negative
      ~Disparity.false_negative_rate
      ~Disparity.false_positive
      ~Disparity.false_positive_rate
      ~Disparity.favorable
      ~Disparity.label_favorable
      ~Disparity.label_odds
      ~Disparity.label_unfavorable
      ~Disparity.observations
      ~Disparity.odds
      ~Disparity.odds_ratio
      ~Disparity.outcome_std
      ~Disparity.p_values
      ~Disparity.percent_difference_favorable
      ~Disparity.percent_difference_unfavorable
      ~Disparity.percent_favorable
      ~Disparity.percent_label_favorable
      ~Disparity.percent_label_unfavorable
      ~Disparity.percent_missing
      ~Disparity.percent_unfavorable
      ~Disparity.plot
      ~Disparity.positive_predictive_value
      ~Disparity.practically_significant
      ~Disparity.quantile_cutoffs
      ~Disparity.quantiles
      ~Disparity.ratio
      ~Disparity.residual_smd
      ~Disparity.residual_std
      ~Disparity.smd
      ~Disparity.total
      ~Disparity.total_label
      ~Disparity.true_negative
      ~Disparity.true_negative_rate
      ~Disparity.true_positive
      ~Disparity.true_positive_rate
      ~Disparity.unfavorable
      ~Disparity.disparity_type
      ~Disparity.summary_table
      ~Disparity.protected_groups
      ~Disparity.reference_groups
      ~Disparity.group_categories
      ~Disparity.statistical_significance
      ~Disparity.stat_sig_test
      ~Disparity.stat_sig_p_values
      ~Disparity.stat_sig_summary_table
      ~Disparity.stat_sig_t_statistics
      ~Disparity.stat_sig_standard_errors
      ~Disparity.stat_sig_z_scores
      ~Disparity.smd_threshold
      ~Disparity.residual_smd_threshold
      ~Disparity.smd_denominator
      ~Disparity.residual_smd_denominator
      ~Disparity.lower_score_favorable
      ~Disparity.odds_ratio_threshold
      ~Disparity.air_threshold
      ~Disparity.percent_difference_threshold
      ~Disparity.population_percent_favorable
      ~Disparity.max_for_fishers
      ~Disparity.alternative_hypothesis
      ~Disparity.quantile_summaries
      ~Disparity.category_summaries
      ~Disparity.summary_table_hstacked
      ~Disparity.quantile_air_results
      ~Disparity.categorical_air_results
      ~Disparity.quantile_statistical_significance_results
      ~Disparity.category_statistical_significance_results
      ~Disparity.input_quantiles
      ~Disparity.ordinal_categories
      ~Disparity.quantile_cutoffs_table
      ~Disparity.outcome_category_mapping
      ~Disparity.segment_air_results
      ~Disparity.segment_summaries
      ~Disparity.segment_statistical_significance_results
      ~Disparity.segments
      ~Disparity.summary_table_across_segments
      ~Disparity.summary_table_by_segments
      ~Disparity.fdr_threshold
      ~Disparity.ratio_calculation
      ~Disparity.ratio_threshold
      ~Disparity.difference_calculation
      ~Disparity.difference_threshold
      ~Disparity.metric_requested
      ~Disparity.metric_requested_name
      ~Disparity.metric_requested_kwargs
      ~Disparity.statistical_significance_test
      ~Disparity.statistical_significance_pvalue_threshold
      ~Disparity.statistical_significance_kwargs
      ~Disparity.metric_columns