## Libraries.Compute.Statistics.Tests.CompareColumnToMean 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.
GetColumn()Returns the name of the column specified.
GetColumnMean()Gets the column mean value.
GetColumnVariance()Gets the column variance value.
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.
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.
SetColumn(text column)Sets the name of the column to be analyzed.
SetMean(number mean)Sets the mean value.

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

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

#### Return

boolean: True if the hash codes are equal and false if they are not equal.

### GetColumn()

Returns the name of the column specified.

text:

### GetColumnMean()

Gets the column mean value.

number:

### GetColumnVariance()

Gets the column variance value.

number:

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

number:

### GetDegreesOfFreedom()

Obtains the degrees of freedom calculated by the test.

number:

### GetFormalSummary()

This action returns a formal academic summary of the result.

text:

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

number:

### GetProbabilityValue()

In Statistics, this is often termed a p-value.

number:

### GetSummary()

This action obtains an informal summary of the result.

text:

### GetUnstandardizedEffectSize()

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

number:

### SetColumn(text column)

Sets the name of the column to be analyzed.

### SetMean(number mean)

Sets the mean value.