Libraries.Compute.Statistics.Tests.CorrelateGroups Documentation

This class implements two tests: Parametric: Correlate2Groups is a Pearson Correlation Coefficient Measures linear relationship between two variables For more information: https://en.wikipedia.org/wiki/Pearson_correlation_coefficient Non-Parametric: Correlate2RankedGroups is a Spearman Correlation Coefficient Measures if two variables move in the same direction, but not at a constant rate For more information: https://en.wikipedia.org/wiki/Spearman%27s_rank_correlation_coefficient

Example Code

use Libraries.Compute.Statistics.DataFrame
use Libraries.Compute.Statistics.Tests.CorrelateGroups

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

CorrelateGroups correlate
correlate:Add(0)
correlate:Add(1)
frame:Calculate(correlate)

output correlate:GetCorrelation()

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

Actions Documentation

AddColumn(integer column)

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

Parameters

  • integer column

AddFactor(integer column)

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

Parameters

  • integer column

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.

Parameters

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)

Correlate2Groups(Libraries.Compute.Statistics.DataFrame frame)

Pearson Correlation Null hypothesis: The groups are not correlated Alternative hypothesis: The groups are correlated

Parameters

Example


    use Libraries.Compute.Statistics.DataFrame
    use Libraries.Compute.Statistics.Tests.CorrelateGroups

    DataFrame frame
    frame:Load("data.csv")

    CorrelateGroups correlate
    correlate:AddColumn(0)
    correlate:AddColumn(1)
    correlate:Calculate(frame)
    output correlate:GetSummary()

Correlate2RankedGroups(Libraries.Compute.Statistics.DataFrame frame)

Spearman Rank Correlation Null hypothesis: The groups are not correlated Alternative hypothesis: The groups are correlated

Parameters

Example


    use Libraries.Compute.Statistics.DataFrame
    use Libraries.Compute.Statistics.Tests.CorrelateGroups

    DataFrame frame
    frame:Load("data.csv")

    CorrelateGroups correlate
    correlate:AddColumn(0)
    correlate:AddColumn(1)
    correlate:Ranked(true)
    correlate:Calculate(frame)
    output correlate:GetSummary()

EmptyColumns()

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

EmptyFactors()

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

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

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)

GetColumn(integer index)

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

Parameters

  • integer index

Return

integer: The item at the given location.

GetColumnIterator()

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

Return

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

GetColumnSize()

This action gets the size of the array.

Return

integer:

GetCorrelation()

This returns the correlation if only one result exists.

Return

number: the correlation

GetCorrelations()

This returns the correlations of all results in a dataframe

Return

Libraries.Compute.Statistics.DataFrame: the correlation frame

GetDegreesOfFreedom()

This returns the degrees of freedom if only one result exists.

Return

number: the Degrees of Freedom.

GetFactor(integer index)

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

Parameters

  • integer index

Return

integer: The item at the given location.

GetFactorIterator()

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

Return

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

GetFactorSize()

This action gets the size of the array.

Return

integer:

GetFactorText()

Return

text

GetFormalSummary()

This action summarizes the results and places them into formal academic language, in APA format. For more information: https://apastyle.apa.org/instructional-aids/numbers-statistics-guide.pdf

Return

text:

Example

use Libraries.Compute.Statistics.DataFrame
use Libraries.Compute.Statistics.Tests.CorrelateGroups
    
DataFrame frame
frame:Load("Data/Data.csv")
    
CorrelateGroups correlate
correlate:AddColumn(0)
correlate:AddColumn(1)
frame:Calculate(correlate)

output correlate:GetFormalSummary()

GetGroups(Libraries.Compute.Statistics.DataFrame frame)

Gets the the fully factored samples/groups in an array of dataframes. Using an array of dataframes instead of a single dataframe helps with multivariate cases.

Parameters

Return

Libraries.Containers.HashTable:

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

GetProbabilities()

This returns the probabilities of all results in a dataframe

Return

Libraries.Compute.Statistics.DataFrame: the probability frame

GetProbabilityValue()

This returns the probability if only one result exists.

Return

number: the P-Value.

GetResult()

This returns a result if only one exists.

Return

Libraries.Compute.Statistics.Reporting.CorrelateGroupsResult: the CorrelateGroupsResult object

Example

use Libraries.Compute.Statistics.DataFrame
use Libraries.Compute.Statistics.Tests.CorrelateGroups
    
DataFrame frame
frame:Load("Data/Data.csv")

CorrelateGroups correlate
correlate:AddColumn(0)
correlate:AddColumn(1)
correlate:Calculate(frame)

CorrelateGroupsResult result = correlate:GetResult()

GetResults()

This returns the results between all computed columns.

Return

Libraries.Containers.Array: the CorrelateGroupsResults.

Example

use Libraries.Compute.Statistics.DataFrame
use Libraries.Compute.Statistics.Tests.CorrelateGroups
    
DataFrame frame
frame:Load("Data/Data.csv")
    
CorrelateGroups correlate
correlate:AddColumn(0)
correlate:AddColumn(1)
correlate:AddColumn(2)
frame:Calculate(correlate)

Array<CorrelateGroupsResult> results = correlate:GetResults()

GetSignificanceLevel()

A list of unique items of the factor

Return

number:

GetStatisticalFormatting()

Fill in new frame

Return

Libraries.Compute.Statistics.Reporting.StatisticsFormatting:

GetSummary()

This action summarizes the results and lists them informally.

Return

text:

Example

use Libraries.Compute.Statistics.DataFrame
use Libraries.Compute.Statistics.Tests.CorrelateGroups
    
DataFrame frame
frame:Load("Data/Data.csv")
    
CorrelateGroups correlate
correlate:AddColumn(0)
correlate:AddColumn(1)
frame:Calculate(correlate)

output correlate:GetSummary()

GetSummaryDataFrame()

Return

Libraries.Compute.Statistics.DataFrame: a DataFrame of the important statistics of the test

Example

use Libraries.Compute.Statistics.DataFrame
use Libraries.Compute.Statistics.Tests.CorrelateGroups
    
DataFrame frame
frame:Load("Data/Data.csv")
    
CorrelateGroups correlate
correlate:Add(0)
correlate:Add(1)
correlate:Add(2)
frame:Calculate(correlate)

DataFrame result = correlate:GetSummaryDataFrame()
result:Save("myresult.csv")

GetTestStatistic()

This returns the test statistic if only one result exists.

Return

number: the test statistic.

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

IsEmptyFactors()

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

Ranked()

Return

boolean

Ranked(boolean ranked)

Parameters

  • boolean ranked

RemoveColumn(integer column)

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

Parameters

  • integer column

Return

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

RemoveColumnAt(integer index)

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

Parameters

  • integer index

RemoveFactor(integer column)

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

Parameters

  • integer column

Return

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

RemoveFactorAt(integer index)

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

Parameters

  • integer index

SetSignificanceLevel(number significanceLevel)

Sets the significance level of the test (default is 0.05).

Parameters

  • number significanceLevel: the significance level between 0 and 1.

SetStatisticalFormatting(Libraries.Compute.Statistics.Reporting.StatisticsFormatting formatting)

Create a new frame based on that list

Parameters

UseFactor()

Return

boolean