rhino_health.lib.metrics.epidemiology.two_by_two_table_based_metrics

Module Contents

Classes

TwoByTwoTableBasedMetric	Abstract class for metrics that are based on a two by two table
TwoByTwoTable	Returns the two by two table of entries for a specified VARIABLE
OddsRatio	Returns the odds ratio of entries for a specified VARIABLE
Odds	Returns the odds of entries for a specified VARIABLE where the odd is calculated by the ratio of the number of true
Risk	Returns the risk of entries for a specified VARIABLE
RiskRatio	Returns the risk ratio of entries for a specified VARIABLE

class rhino_health.lib.metrics.epidemiology.two_by_two_table_based_metrics.TwoByTwoTableBasedMetric(**kwargs)

Bases: rhino_health.lib.metrics.base_metric.AggregatableMetric, abc.ABC

Abstract class for metrics that are based on a two by two table

variable: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName

detected_column_name: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName

exposed_column_name: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName

class rhino_health.lib.metrics.epidemiology.two_by_two_table_based_metrics.TwoByTwoTable(**kwargs)

Bases: TwoByTwoTableBasedMetric

Returns the two by two table of entries for a specified VARIABLE

property metric_response

Returns the response class for the metric

class rhino_health.lib.metrics.epidemiology.two_by_two_table_based_metrics.OddsRatio(**kwargs)

Bases: TwoByTwoTableBasedMetric

Returns the odds ratio of entries for a specified VARIABLE

class rhino_health.lib.metrics.epidemiology.two_by_two_table_based_metrics.Odds(**kwargs)

Bases: rhino_health.lib.metrics.base_metric.AggregatableMetric

Returns the odds of entries for a specified VARIABLE where the odd is calculated by the ratio of the number of true

occurrences to the number of false occurrences.

variable: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName

column_name: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName

class rhino_health.lib.metrics.epidemiology.two_by_two_table_based_metrics.Risk(**kwargs)

Bases: TwoByTwoTableBasedMetric

Returns the risk of entries for a specified VARIABLE

class rhino_health.lib.metrics.epidemiology.two_by_two_table_based_metrics.RiskRatio(**kwargs)

Bases: TwoByTwoTableBasedMetric

Returns the risk ratio of entries for a specified VARIABLE