`rhino_health.lib.metrics.basic`#

Module Contents#

`Count`	Returns the count of entries for a specified VARIABLE
`Mean`	Returns the mean value of a specified VARIABLE
`StandardDeviation`	Returns the standard deviation of a specified VARIABLE
`Sum`	Returns the sum of a specified VARIABLE

class rhino_health.lib.metrics.basic.Count(**data)#

Bases: rhino_health.lib.metrics.base_metric.JoinableMetric

Returns the count of entries for a specified VARIABLE

variable: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName#

join_mode: JoinMode | None#: The mode to perform an optional Federated Join in. Defaults to intersection if join_field, query_datasets, or filter_datasets are defined

join_field: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName | None#: A field to perform a join on if performing a Federated Join. This filter_variable will be performed on the filter_dataset(s)

class rhino_health.lib.metrics.basic.Mean(**data)#

Bases: rhino_health.lib.metrics.base_metric.JoinableMetric

Returns the mean value of a specified VARIABLE

variable: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName#

join_mode: JoinMode | None#: The mode to perform an optional Federated Join in. Defaults to intersection if join_field, query_datasets, or filter_datasets are defined

join_field: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName | None#: A field to perform a join on if performing a Federated Join. This filter_variable will be performed on the filter_dataset(s)

class rhino_health.lib.metrics.basic.StandardDeviation(**data)#

Bases: rhino_health.lib.metrics.base_metric.JoinableMetric

Returns the standard deviation of a specified VARIABLE

variable: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName#

join_mode: JoinMode | None#: The mode to perform an optional Federated Join in. Defaults to intersection if join_field, query_datasets, or filter_datasets are defined

join_field: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName | None#: A field to perform a join on if performing a Federated Join. This filter_variable will be performed on the filter_dataset(s)

class rhino_health.lib.metrics.basic.Sum(**data)#

Bases: rhino_health.lib.metrics.base_metric.JoinableMetric

Returns the sum of a specified VARIABLE

variable: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName#

join_mode: JoinMode | None#: The mode to perform an optional Federated Join in. Defaults to intersection if join_field, query_datasets, or filter_datasets are defined

join_field: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName | None#: A field to perform a join on if performing a Federated Join. This filter_variable will be performed on the filter_dataset(s)