Class: DatadogAPIClient::V2::ExperimentsVariantResultsV2DTODataAttributesMetricsItemsAnalysesItems

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb

Overview

One statistical comparison for a metric and variant.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



87
88
89
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 87

def additional_properties
  @additional_properties
end

#confidence_interval ⇒ Object

Lower and upper bounds of the reported statistical interval.



25
26
27
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 25

def confidence_interval
  @confidence_interval
end

#confidence_level ⇒ Object

Configured nominal confidence level. Interval bounds can use an adjusted level for multiple testing or hybrid methods.



28
29
30
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 28

def confidence_level
  @confidence_level
end

#evsi ⇒ Object

Expected reduction in minimum expected regret from collecting more sample data.



31
32
33
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 31

def evsi
  @evsi
end

#expectation_above_zero ⇒ Object

Expected effect when the effect is positive.



34
35
36
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 34

def expectation_above_zero
  @expectation_above_zero
end

#expectation_below_zero ⇒ Object

Expected effect when the effect is negative.



37
38
39
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 37

def expectation_below_zero
  @expectation_below_zero
end

#global_lift ⇒ Object

Estimated lift across the population. Calculated as metric coverage multiplied by the experiment lift.



40
41
42
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 40

def global_lift
  @global_lift
end

#global_lift_lower_bound ⇒ Object

Lower bound of the estimated lift across the population.



43
44
45
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 43

def global_lift_lower_bound
  @global_lift_lower_bound
end

#global_lift_upper_bound ⇒ Object

Upper bound of the estimated lift across the population.



46
47
48
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 46

def global_lift_upper_bound
  @global_lift_upper_bound
end

#is_cuped_adjusted ⇒ Object

Whether CUPED used pre-experiment data to reduce variance in this result.



49
50
51
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 49

def is_cuped_adjusted
  @is_cuped_adjusted
end

#is_unreliable ⇒ Object

Whether the statistical result is marked as unreliable.



52
53
54
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 52

def is_unreliable
  @is_unreliable
end

#lift_type ⇒ Object

Whether the reported lift is relative or absolute.



55
56
57
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 55

def lift_type
  @lift_type
end

#method ⇒ Object

Statistical method used to calculate this result.



58
59
60
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 58

def method
  @method
end

#minimum_expected_regret ⇒ Object

The smaller expected opportunity cost of choosing treatment or control.



61
62
63
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 61

def minimum_expected_regret
  @minimum_expected_regret
end

#p_value ⇒ Object

Probability, under the no-effect hypothesis, of a result at least as extreme as the observed result.



64
65
66
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 64

def p_value
  @p_value
end

#point_estimate ⇒ Object

Estimated difference between the variant and control for this metric.



67
68
69
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 67

def point_estimate
  @point_estimate
end

#probability_above_zero ⇒ Object

Estimated probability that the effect is greater than zero.



70
71
72
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 70

def probability_above_zero
  @probability_above_zero
end

#probability_below_zero ⇒ Object

Estimated probability that the effect is less than zero.



73
74
75
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 73

def probability_below_zero
  @probability_below_zero
end

#standard_error ⇒ Object

Estimated uncertainty in the effect estimate.



76
77
78
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 76

def standard_error
  @standard_error
end

#unreliable_reason ⇒ Object

Reason that the statistical result is marked as unreliable.



79
80
81
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 79

def unreliable_reason
  @unreliable_reason
end

#variant_metric_value ⇒ Object

Metric value calculated for this variant.



82
83
84
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 82

def variant_metric_value
  @variant_metric_value
end

#z_score ⇒ Object

Standardized statistic used to compare the observed effect with zero.



85
86
87
 
# File 'lib/datadog_api_client/v2/models/experiments_variant_results_v2_dto_data_attributes_metrics_items_analyses_items.rb', line 85

def z_score
  @z_score
end