Libraries.Compute.Statistics.Reporting.StatisticsFormatting Documentation

This class handles some basic formatting operations for statistical reporting. By default It uses the conventions from the American Psychological Association. See their Statistics guide for more information: https://apastyle.apa.org/instructional-aids/numbers-statistics-guide.pdf

Inherits from: Libraries.Language.Object

Summary

Variable Summary Table

VariablesDescription
number PRECISION_LIMIT

Actions Summary Table

ActionsDescription
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.
FormatCorrelation(number value)This action formats specifically the correlation for a particular statistical test.
FormatDegreesOfFreedom(number value)This action formats specifically the degrees of freedom for a particular statistical test.
FormatProbabilityValue(number value)This action formats specifically the p-value for a particular statistical test.
GetCorrelationSignificantDigits()The number of significant digits for correlations
GetHashCode()This action gets the hash code for an object.
GetProbabilitySignificantDigits()The number of significant digits for p-values
GetSignificantDigits()The number of significant digits for other tests
SetCorrelationSignificantDigits(integer correlationSignificantDigits)The number of significant digits for correlations
SetProbabilitySignificantDigits(integer probabilitySignificantDigits)The number of significant digits for p-values
SetSignificantDigits(integer significantDigits)The number of significant digits for other tests

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)

Parameters

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)

Parameters

Return

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

FormatCorrelation(number value)

This action formats specifically the correlation for a particular statistical test.

Parameters

Return

text:

FormatDegreesOfFreedom(number value)

This action formats specifically the degrees of freedom for a particular statistical test.

Parameters

Return

text:

FormatProbabilityValue(number value)

This action formats specifically the p-value for a particular statistical test.

Parameters

Return

text:

GetCorrelationSignificantDigits()

The number of significant digits for correlations

Return

integer:

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.

GetProbabilitySignificantDigits()

The number of significant digits for p-values

Return

integer:

GetSignificantDigits()

The number of significant digits for other tests

Return

integer:

SetCorrelationSignificantDigits(integer correlationSignificantDigits)

The number of significant digits for correlations

Parameters

SetProbabilitySignificantDigits(integer probabilitySignificantDigits)

The number of significant digits for p-values

Parameters

SetSignificantDigits(integer significantDigits)

The number of significant digits for other tests

Parameters