Libraries.Compute.Statistics.Reporting.CompareCountsResult Documentation
This class represents data that comes back from a CompareCounts calculation (chi-squared test).
Inherits from: Libraries.Language.Object, Libraries.Compute.Statistics.Reporting.StatisticalTestResult
Actions Documentation
Compare(Libraries.Language.Object object)
This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.
Parameters
- Libraries.Language.Object: The object to compare to.
Return
integer: The Compare result, Smaller, Equal, or Larger.
Example
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)
Equals(Libraries.Language.Object object)
This action determines if two objects are equal based on their hash code values.
Parameters
- Libraries.Language.Object: The to be compared.
Return
boolean: True if the hash codes are equal and false if they are not equal.
Example
use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)
GetApproximationWarningFlag()
Obtains the warning flag set by the test.
Return
boolean: the warning flag boolean.
GetCriticalValue()
This indicates the critical value for any statistical test that was run
Return
number: the critical value
GetDegreesOfFreedom()
Obtains the degrees of freedom value (df in statistics) calculated by the test.
Return
number: the degrees of freedom
GetEffectSize()
Returns the effect size used for this test.
Return
number: the effect size used for this test.
GetEffectSizeName()
Returns the name of the effect size used for this test.
Return
text: the name of the effect size used for this test.
GetExpected()
Obtains the expected dataframe calculated by the test.
Return
Libraries.Compute.Statistics.DataFrame: the expected values in a dataframe.
GetFormalNumericalResult()
P-value > α: Cannot conclude that the variables are associated (Fail to reject H0)
Return
text:
GetFormalSummary()
This action summarizes the result and places it into formal academic language, in APA format. For more information: https://apastyle.apa.org/instructional-aids/numbers-statistics-guide.pdf
Return
text:
GetFormalTestName()
Returns the name of the test in formal mathematical language.
Return
text: the name of the test in mathematical language.
GetFormat()
Returns true if this result is significant against the significance level
Return
Libraries.Compute.Statistics.Reporting.StatisticsFormatting:
GetHashCode()
This action gets the hash code for an object.
Return
integer: The integer hash code of the object.
Example
Object o
integer hash = o:GetHashCode()
GetObserved()
Obtains the observed dataframe calculated by the test.
Return
Libraries.Compute.Statistics.DataFrame: the observed values in a dataframe.
GetProbabilityValue()
Obtains the probability value (p in statistics) calculated by the test.
Return
number: the probability
GetResiduals()
Obtains the pearson residuals dataframe calculated by the test.
Return
Libraries.Compute.Statistics.DataFrame: the residual values in a dataframe.
GetSampleSize()
Obtains the sample size for the test.
Return
integer: the sample size.
GetSignificanceLevel()
Obtains the significance level.
Return
number: the significance level.
GetSummary()
This action summarizes the result and lists it informally. It does not list the observed, expected or residual dataframes as those can be very large. If those are wanted, it's best to get them separately.
Return
text:
GetTestStatistic()
This indicates the test statistic for any statistical test that was run
Return
number: the test statistic
IsSignificant()
Returns true if this result is significant against the significance level
Return
boolean:
SetApproximationWarningFlag(boolean flag)
Sets the warning flag for the test.
Parameters
- boolean flag
SetCriticalValue(number criticalValue)
This sets the critical value for any statistical test that was run
Parameters
- number criticalValue
SetDegreesOfFreedom(number degreesOfFreedom)
Sets the degrees of freedom value (df in statistics) calculated by the test.
Parameters
- number degreesOfFreedom: the degrees of freedom
SetEffectSize(number effectSize)
Sets the effect size used for this test.
Parameters
- number effectSize: is the effect size used for this test.
SetEffectSizeName(text effectSizeName)
Sets the name of the effect size used for this test.
Parameters
- text effectSizeName: is the name of the effect size used for this test.
SetExpected(Libraries.Compute.Statistics.DataFrame expected)
Sets the expected dataframe calculated by the test.
Parameters
- Libraries.Compute.Statistics.DataFrame: the dataframe of expected values
SetFactor(text factor)
Sets the factor (if used) used in this calculation.
Parameters
- text factor
SetFormalTestName(text formalTestName)
Sets the name of the test in formal mathematical language.
Parameters
- text formalTestName: the name of the test in mathematical language.
SetFormat(Libraries.Compute.Statistics.Reporting.StatisticsFormatting format)
Sets the significance level of the test (default is 0.05).
Parameters
SetGoodnessOfFit(boolean goodnessOfFit)
Sets the goodness of fit flag for the test.
Parameters
- boolean goodnessOfFit: is true if the result comes from a goodness of fit test.
SetObserved(Libraries.Compute.Statistics.DataFrame observed)
Sets the observed dataframe calculated by the test.
Parameters
- Libraries.Compute.Statistics.DataFrame: the dataframe of observed values
SetProbabilityValue(number probabilityValue)
Sets the probability value (p in statistics) calculated by the test.
Parameters
- number probabilityValue: the probability
SetResiduals(Libraries.Compute.Statistics.DataFrame residuals)
Sets the residuals dataframe calculated by the test.
Parameters
- Libraries.Compute.Statistics.DataFrame: the dataframe of residual values
SetSampleSize(integer sampleSize)
Sets the sample size for the test.
Parameters
- integer sampleSize: is sample size.
SetSignificanceLevel(number significanceLevel)
Sets the significance level of the test (default is 0.05).
Parameters
- number significanceLevel: the significance level between 0 and 1.
SetTestStatistic(number testStatistic)
This sets the calculated test statistic for any statistical test that was run
Parameters
- number testStatistic
SetVariable1(text variable)
Sets the first column (or only column) used in this calculation.
Parameters
- text variable: is column header.
SetVariable2(text variable)
Sets the second column (if used) used in this calculation.
Parameters
- text variable: is column header.
On this page
Variables TableAction Documentation- Compare(Libraries.Language.Object object)
- Equals(Libraries.Language.Object object)
- GetApproximationWarningFlag()
- GetCriticalValue()
- GetDegreesOfFreedom()
- GetEffectSize()
- GetEffectSizeName()
- GetExpected()
- GetFormalNumericalResult()
- GetFormalSummary()
- GetFormalTestName()
- GetFormat()
- GetHashCode()
- GetObserved()
- GetProbabilityValue()
- GetResiduals()
- GetSampleSize()
- GetSignificanceLevel()
- GetSummary()
- GetTestStatistic()
- IsSignificant()
- SetApproximationWarningFlag(boolean flag)
- SetCriticalValue(number criticalValue)
- SetDegreesOfFreedom(number degreesOfFreedom)
- SetEffectSize(number effectSize)
- SetEffectSizeName(text effectSizeName)
- SetExpected(Libraries.Compute.Statistics.DataFrame expected)
- SetFactor(text factor)
- SetFormalTestName(text formalTestName)
- SetFormat(Libraries.Compute.Statistics.Reporting.StatisticsFormatting format)
- SetGoodnessOfFit(boolean goodnessOfFit)
- SetObserved(Libraries.Compute.Statistics.DataFrame observed)
- SetProbabilityValue(number probabilityValue)
- SetResiduals(Libraries.Compute.Statistics.DataFrame residuals)
- SetSampleSize(integer sampleSize)
- SetSignificanceLevel(number significanceLevel)
- SetTestStatistic(number testStatistic)
- SetVariable1(text variable)
- SetVariable2(text variable)