Libraries.Compute.Statistics.Reporting.CorrelateGroupsResult Documentation

This class represents data that comes back from a CorrelateGroups calculation (Pearson or Spearman correlation).

Inherits from: Libraries.Language.Object, Libraries.Compute.Statistics.Reporting.StatisticalTestResult

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.

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)

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)

GetChart()

This action summarizes the result and lists it informally.

Return

Libraries.Interface.Controls.Charts.ScatterPlot:

GetCorrelation()

Obtains the correlation calculated by the test. This may be of any kind.

Return

number: the correlation

GetCriticalValue()

This indicates the critical value for any statistical test that was run

Return

number: the critical value

GetDegreesOfFreedom()

Obtains the degrees of freedom value (df in statistics) calculated by the test.

Return

number: the degrees of freedom

GetDescriptiveStatisticsDataFrame()

This action returns the formal numrical result in APA format. For more information: https://apastyle.apa.org/instructional-aids/numbers-statistics-guide.pdf Correlate2Groups (Pearson Correlation) Numerical result format: r(degress of freedom) = correlation, p = probability-value Example: r(4) = .23, p = .667 Correlate2RankedGroups (Spearman Correlation) Numerical result format: rs(degress of freedom) = correlation, p = probability-value Example: rs(4) = .03, p = .957

Return

Libraries.Compute.Statistics.DataFrame:

GetEffectSize()

Returns the effect size used for this test.

Return

number: the effect size used for this test.

GetEffectSizeName()

Returns the name of the effect size used for this test.

Return

text: the name of the effect size used for this test.

GetExperimentalDesign()

Return

Libraries.Compute.Statistics.Tests.ExperimentalDesign

GetFactor()

Returns the factor, if used in this calculation

Return

text:

GetFormalNumericalResult()

This action returns the formal numrical result in APA format. For more information: https://apastyle.apa.org/instructional-aids/numbers-statistics-guide.pdf Correlate2Groups (Pearson Correlation) Numerical result format: r(degress of freedom) = correlation, p = probability-value Example: r(4) = .23, p = .667 Correlate2RankedGroups (Spearman Correlation) Numerical result format: rs(degress of freedom) = correlation, p = probability-value Example: rs(4) = .03, p = .957

Return

text:

GetFormalSummary()

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

Return

text:

GetFormalTestName()

Returns the name of the test in formal mathematical language.

Return

text: the name of the test in mathematical language.

GetFormat()

Returns true if this result is significant against the significance level

Return

Libraries.Compute.Statistics.Reporting.StatisticsFormatting:

GetGroups()

Returns the groups used in this calculation

Return

Libraries.Containers.Array:

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

GetProbabilityValue()

Obtains the probability value (p in statistics) calculated by the test.

Return

number: the probability

GetReport(Libraries.System.File file)

Sets the correlation calculated by the test. This may be of any kind.

Parameters

GetReportDiv()

add the meta-data character set

Return

Libraries.Web.Page.Division:

GetSignificanceLevel()

Obtains the significance level.

Return

number: the significance level.

GetSummary()

This action summarizes the result and lists it informally.

Return

text:

GetSummaryDataFrame()

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

Return

Libraries.Compute.Statistics.DataFrame:

GetTestStatistic()

This indicates the test statistic for any statistical test that was run

Return

number: the test statistic

IsSignificant()

Returns true if this result is significant against the significance level

Return

boolean:

Ranked()

Sets the groups used in this calculation

Return

boolean:

Ranked(boolean ranked)

Returns the groups used in this calculation

Parameters

  • boolean ranked

SetCorrelation(number correlation)

Sets the correlation calculated by the test. This may be of any kind.

Parameters

  • number correlation: the correlation

SetCriticalValue(number criticalValue)

This sets the critical value for any statistical test that was run

Parameters

  • number criticalValue

SetDegreesOfFreedom(number degreesOfFreedom)

Sets the degrees of freedom value (df in statistics) calculated by the test.

Parameters

  • number degreesOfFreedom: the degrees of freedom

SetEffectSize(number effectSize)

Sets the effect size used for this test.

Parameters

  • number effectSize: is the effect size used for this test.

SetEffectSizeName(text effectSizeName)

Sets the name of the effect size used for this test.

Parameters

  • text effectSizeName: is the name of the effect size used for this test.

SetExperimentalDesign(Libraries.Compute.Statistics.Tests.ExperimentalDesign design)

Parameters

SetFactor(text factor)

Sets the factor, if used in this calculation

Parameters

  • text factor

SetFormalTestName(text formalTestName)

Sets the name of the test in formal mathematical language.

Parameters

  • text formalTestName: the name of the test in mathematical language.

SetFormat(Libraries.Compute.Statistics.Reporting.StatisticsFormatting format)

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

Parameters

SetGroups(Libraries.Compute.Statistics.DataFrameColumn group1, Libraries.Compute.Statistics.DataFrameColumn group2)

Sets the groups used in this calculation

Parameters

SetProbabilityValue(number probabilityValue)

Sets the probability value (p in statistics) calculated by the test.

Parameters

  • number probabilityValue: the probability

SetSignificanceLevel(number significanceLevel)

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

Parameters

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

SetTestStatistic(number testStatistic)

This sets the calculated test statistic for any statistical test that was run

Parameters

  • number testStatistic