Expect the Z-scores of a column's values to be less than a given threshold.
expect_column_value_z_scores_to_be_less_than
This expectation level is PRODUCTION
Contributors:
Tags:
Metrics:
Description
Expect the Z-scores of a column's values to be less than a given threshold.
expect_column_values_to_be_of_type is a Column Map Expectation for typed-column backends, and also for PandasExecutionEngine where the column dtype and provided type_ are unambiguous constraints (any dtype except 'object' or dtype of 'object' with type_ specified as 'object').
Args:
- column (str): The column name of a numerical column.
- threshold (number): A maximum Z-score threshold. All column Z-scores that are lower than this threshold will evaluate successfully.
Keyword Args:
- mostly (None or a float between 0 and 1): Successful if at least mostly fraction of values match the expectation. For more detail, see mostly.
- double_sided (boolean): A True or False value indicating whether to evaluate double sidedly. Examples... (double_sided = True, threshold = 2) -> Z scores in non-inclusive interval(-2,2) | (double_sided = False, threshold = 2) -> Z scores in non-inclusive interval (-infinity,2)
Other Parameters:
- result_format (str or None): Which output mode to use: BOOLEAN_ONLY, BASIC, COMPLETE, or SUMMARY. For more detail, see result_format.
- include_config (boolean): If True, then include the Expectation config as part of the result object.
- catch_exceptions (boolean or None): If True, then catch exceptions and include them as part of the result object. For more detail, see catch_exceptions.
- meta (dict or None): A JSON-serializable dictionary (nesting allowed) that will be included in the output without modification. For more detail, see meta.
Returns:
Exact fields vary depending on the values passed to result_format, include_config, catch_exceptions, and meta.
Want to make your own Expectation or an improvement to this one?
We've put together some great how to guides (including videos) on how to create your own expectations in a flash!
You can see those resources here: Contributor Resources