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

Variables Table

VariablesDescription
number PRECISION_LIMIT

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)

FormatCorrelation(number value)

This action formats specifically the correlation for a particular statistical test. This applies for statistics that CANNOT be greater than 1. Remove leading 0.

Parameters

  • number value: the value to format

Return

text:

FormatCriticalValue(number value)

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

Parameters

  • number value: the value to format

Return

text:

FormatDegreesOfFreedom(number value)

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

Parameters

  • number value: the value to format

Return

text:

FormatProbabilityValue(number value)

This action formats specifically the p-value for a particular statistical test. This applies for statistics that CANNOT be greater than 1. Remove leading 0.

Parameters

  • number value: the p-value to format

Return

text:

FormatTestStatistic(number value)

This action formats specifically the test statistic (t-value, x2-value) for a particular statistical test. This applies for statistics that CAN be greater than 1. Keep the leading 0.

Parameters

  • number value: the value to format

Return

text:

FormatWithoutLeadingZero(number value, integer significantDigits)

This action formats any value that require the leading 0 to be drop but need more or less decimal places than correlation and are not formatted like probability. This applies for statistics that CANNOT be greater than 1. Remove leading 0.

Parameters

  • number value: the value to format
  • integer significantDigits

Return

text:

GetCorrelationSignificantDigits()

The number of significant digits for correlations

Return

integer:

GetCriticalValueSignificantDigits()

The number of significant digits for test statistics (t-value, x2 value, f-value, etc)

Return

integer:

GetDegreesOfFreedomSignificantDigits()

The number of significant digits for degrees of freedom

Return

integer:

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

GetProbabilitySignificantDigits()

The number of significant digits for p-values

Return

integer:

GetSignificantDigits()

The number of significant digits for other tests

Return

integer:

GetTestStatisticSignificantDigits()

The number of significant digits for test statistics (t-value, x2 value, f-value, etc)

Return

integer:

SetCorrelationSignificantDigits(integer correlationSignificantDigits)

The number of significant digits for correlations

Parameters

  • integer correlationSignificantDigits

SetCriticalValueSignificantDigits(integer criticalValueSignificantDigits)

The number of significant digits for test statistics (t-value, x2 value, f-value, etc)

Parameters

  • integer criticalValueSignificantDigits

SetDegreesOfFreedomSignificantDigits(integer degreesOfFreedomSignificantDigits)

The number of significant digits for degrees of freedom

Parameters

  • integer degreesOfFreedomSignificantDigits

SetProbabilitySignificantDigits(integer probabilitySignificantDigits)

The number of significant digits for p-values

Parameters

  • integer probabilitySignificantDigits

SetSignificantDigits(integer significantDigits)

The number of significant digits for other tests

Parameters

  • integer significantDigits

SetTestStatisticSignificantDigits(integer testStatisticSignificantDigits)

The number of significant digits for test statistics (t-value, x2 value, f-value, etc)

Parameters

  • integer testStatisticSignificantDigits