Libraries.Compute.Statistics.Inputs.FactorInput Documentation

There are many ways in which a statistical test, transform, or calculation could potentially get data from a DataFrame. The Inputs package lists any of these ways. FactorInput specifically is stating that a particular class expects the data to be dummy coded. This means that we are adding a set of columns that indicate group values to be used as a factor. Effectively this means a dependent variable is coded as a column with all groups together and the factor columns indicate levels of an independent variable.

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
AddFactor(integer column)This action adds a value to the end of the input.
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
EmptyFactors()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.
GetFactor(integer index)This action gets the item at a given location in an array.
GetFactorIterator()This action gets an iterator for the object and returns that iterator.
GetFactorSize()This action gets the size of the array.
GetHashCode()This action gets the hash code for an object.
IsEmptyFactors()This action returns a boolean value, true if the container is empty and false if it contains any items.
RemoveFactor(integer column)This action removes the first occurrence of an item that is found in the Addable object.
RemoveFactorAt(integer index)This action removes an item from an indexed object and returns that item.

Actions Documentation

AddFactor(integer column)

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

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.

EmptyFactors()

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.

GetFactor(integer index)

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

Parameters

Return

integer: The item at the given locatio

GetFactorIterator()

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

Return

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

GetFactorSize()

This action gets the size of the array.

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.

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 no

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

RemoveFactorAt(integer index)

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

Parameters