Libraries.Compute.Statistics.Tests.CompareGroups 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.CompareTwoColumns

    DataFrame frame
    frame:Load("Data/Data.csv")

    //independent samples t-test
    CompareTwoColumns compare
    compare:SetColumn1("DT")
    compare:SetColumn1("DRT")
  
    //calculate the t-test and output a summary
    frame:Calculate(compare)
    output compare:GetFormalSummary

Inherits from: Libraries.Compute.Statistics.DataFrameCalculation, Libraries.Compute.Statistics.Inputs.ColumnInput, Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
AddColumn(integer column)This action adds a value to the end of the input.
Calculate(Libraries.Compute.Statistics.DataFrame frame)
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
EmptyColumns()This action empty's the list, clearing out all of the items contained within i
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetColumn(integer index)This action gets the item at a given location in an array.
GetColumnIterator()This action gets an iterator for the object and returns that iterator.
GetColumnSize()This action gets the size of the array.
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
GetHashCode()This action gets the hash code for an object.
GetMean1()Returns the mean of the first colum
GetMean2()Returns the mean of the second colum
GetPairwiseResults()Returns the variance of the first colum
GetProbabilityValue()In Statistics, this is often termed a p-valu
GetResult()This action returns a formal academic summary of the resul
GetSummary()This action obtains an informal summary of the resul
GetVariance1()Returns the variance of the first colum
GetVariance2()Returns the variance of the second colum
IsCorrectingFamilyWiseError()This action obtains an informal summary of the resul
IsEmptyColumns()This action returns a boolean value, true if the container is empty and false if it contains any items.
RemoveColumn(integer column)This action removes the first occurrence of an item that is found in the Addable object.
RemoveColumnAt(integer index)This action removes an item from an indexed object and returns that item.
SetCorrectingFamilyWiseError(boolean correctFamilyWiseError)Returns the variance of the second colum

Actions Documentation

AddColumn(integer column)

This action adds a value to the end of the input.

Parameters

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 (smalle

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

EmptyColumns()

This action empty's the list, clearing out all of the items contained within i

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(

Parameters

Return

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

GetColumn(integer index)

This action gets the item at a given location in an array.

Parameters

Return

integer: The item at the given locatio

GetColumnIterator()

This action gets an iterator for the object and returns that iterator.

Return

Libraries.Containers.Iterator: Returns the iterator for an objec

GetColumnSize()

This action gets the size of the array.

Return

integer:

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

Return

number:

GetDegreesOfFreedom()

Obtains the degrees of freedom calculated by the tes

Return

number:

GetFormalSummary()

This action returns a formal academic summary of the resul

Return

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.

GetMean1()

Returns the mean of the first colum

Return

number:

GetMean2()

Returns the mean of the second colum

Return

number:

GetPairwiseResults()

Returns the variance of the first colum

Return

Libraries.Containers.Array:

GetProbabilityValue()

In Statistics, this is often termed a p-valu

Return

number:

GetResult()

This action returns a formal academic summary of the resul

Return

Libraries.Compute.Statistics.Reporting.CompareGroupsResult:

GetSummary()

This action obtains an informal summary of the resul

Return

text:

GetVariance1()

Returns the variance of the first colum

Return

number:

GetVariance2()

Returns the variance of the second colum

Return

number:

IsCorrectingFamilyWiseError()

This action obtains an informal summary of the resul

Return

boolean:

IsEmptyColumns()

This action returns a boolean value, true if the container is empty and false if it contains any items.

Return

boolean: Returns true when the container is empty and false when it is no

RemoveColumn(integer column)

This action removes the first occurrence of an item that is found in the Addable object.

Parameters

Return

boolean: Returns true if the item was removed and false if it was not remove

RemoveColumnAt(integer index)

This action removes an item from an indexed object and returns that item.

Parameters

SetCorrectingFamilyWiseError(boolean correctFamilyWiseError)

Returns the variance of the second colum

Parameters