## 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

//independent samples t-test
CompareColumnToMean compare
compare:SetColumn1("DT")

//calculate the t-test and output a summary
frame:Calculate(compare)
output compare:GetFormalSummary``````

## Summary

### Actions Summary Table

ActionsDescription
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 tes
GetFormalSummary()This action returns a formal academic summary of the resul
GetGroup()Returns the name of the column specifie
GetGroupMean()Gets the column mean valu
GetGroupVariance()Gets the column variance valu
GetHashCode()This action gets the hash code for an object.
GetMean()Gets the mean valu
GetProbabilityValue()In Statistics, this is often termed a p-valu
GetSummary()This action obtains an informal summary of the resul
GetUnstandardizedEffectSize()This action returns the unstandardized effect size.
SetGroup(integer column)Sets the name of the column to be analyze
SetMean(number mean)Sets the mean valu

## 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.

Example Code

``````Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smalle``````

#### 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(``````

#### 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-valu

number:

### GetDegreesOfFreedom()

Obtains the degrees of freedom calculated by the tes

number:

### GetFormalSummary()

This action returns a formal academic summary of the resul

text:

### GetGroup()

Returns the name of the column specifie

integer:

### GetGroupMean()

Gets the column mean valu

number:

### GetGroupVariance()

Gets the column variance valu

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 valu

number:

### GetProbabilityValue()

In Statistics, this is often termed a p-valu

number:

### GetSummary()

This action obtains an informal summary of the resul

text:

### GetUnstandardizedEffectSize()

This action returns the unstandardized effect size. By default, this value is Cohen's D: https://en.wikipedia.org/wiki/Effect_si

number:

### SetGroup(integer column)

Sets the name of the column to be analyze

### SetMean(number mean)

Sets the mean valu