Libraries.Compute.Statistics.Tests.CompareGroupToMean Documentation
This class implements a one-sample t-test. For more information, see this: https://en.wikipedia.org/wiki/Student%27s_t-test
Example Code
use Libraries.Compute.Statistics.DataFrame
use Libraries.Compute.Statistics.Tests.CompareColumnToMean
DataFrame frame
frame:Load("Data/Data.csv")
//independent samples t-test
CompareColumnToMean compare
compare:SetColumn1("DT")
//calculate the t-test and output a summary
frame:Calculate(compare)
output compare:GetFormalSummary()
Inherits from: Libraries.Compute.Statistics.DataFrameCalculation, Libraries.Language.Object
Summary
Actions Summary Table
Actions | Description |
---|---|
Calculate(Libraries.Compute.Statistics.DataFrame frame) | |
Compare(Libraries.Language.Object object) | This action compares two object hash codes and returns an integer. |
Equals(Libraries.Language.Object object) | This action determines if two objects are equal based on their hash code values. |
GetCriticalValue() | This returns a critical value, or the place on the distribution where are caluclating our probability values from. |
GetDegreesOfFreedom() | Obtains the degrees of freedom calculated by the test. |
GetFormalSummary() | This action returns a formal academic summary of the result. |
GetGroup() | Returns the name of the column specified. |
GetGroupMean() | Gets the column mean value. |
GetGroupVariance() | Gets the column variance value. |
GetHashCode() | This action gets the hash code for an object. |
GetMean() | Gets the mean value. |
GetProbabilityValue() | In Statistics, this is often termed a p-value. |
GetSummary() | This action obtains an informal summary of the result. |
GetUnstandardizedEffectSize() | This action returns the unstandardized effect size. |
SetGroup(integer column) | Sets the name of the column to be analyzed. |
SetMean(number mean) | Sets the mean value. |
Actions Documentation
Calculate(Libraries.Compute.Statistics.DataFrame frame)
Parameters
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.
Example Code
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)
Parameters
- Libraries.Language.Object: The object to compare to.
Return
integer: The Compare result, Smaller, Equal, or Larger.
Equals(Libraries.Language.Object object)
This action determines if two objects are equal based on their hash code values.
Example Code
use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)
Parameters
- Libraries.Language.Object: The to be compared.
Return
boolean: True if the hash codes are equal and false if they are not equal.
GetCriticalValue()
This returns a critical value, or the place on the distribution where are caluclating our probability values from. The critical value, for a test like a t-test, would be equivalent to a t-value.
Return
number:
GetDegreesOfFreedom()
Obtains the degrees of freedom calculated by the test.
Return
number:
GetFormalSummary()
This action returns a formal academic summary of the result.
Return
text:
GetGroup()
Returns the name of the column specified.
Return
integer:
GetGroupMean()
Gets the column mean value.
Return
number:
GetGroupVariance()
Gets the column variance value.
Return
number:
GetHashCode()
This action gets the hash code for an object.
Example Code
Object o
integer hash = o:GetHashCode()
Return
integer: The integer hash code of the object.
GetMean()
Gets the mean value.
Return
number:
GetProbabilityValue()
In Statistics, this is often termed a p-value.
Return
number:
GetSummary()
This action obtains an informal summary of the result.
Return
text:
GetUnstandardizedEffectSize()
This action returns the unstandardized effect size. By default, this value is Cohen's D: https://en.wikipedia.org/wiki/Effect_size
Return
number:
SetGroup(integer column)
Sets the name of the column to be analyzed.
Parameters
SetMean(number mean)
Sets the mean value.