Libraries.Compute.Statistics.Charts.HistogramCreator Documentation

This class is used to create a Histogram from columns of data in a DataFrame. There is one way to make a histogram from the data frame using this class: 1. One or more numerical columns: Default will create bin widths based on Freedman-Diaconis rule for bin widths. By default, it uses the Freedman-Diaconis rule for bin widths, which provides a reasonable looking histogram in most cases. More information can be found at: https://en.wikipedia.org/wiki/Freedman%E2%80%93Diaconis_rule

Example Code

use Libraries.Compute.Statistics.DataFrame
use Libraries.Compute.Statistics.Charts.HistogramCreator

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

//Create a Bar Chart and set some properties
DataFrame frame
frame:Load("Data/Data.csv")

HistogramCreator creator
creator:SetValueColumn("DRT")

Chart chart = frame:CreateChart(creator)

chart:SetTitle("Histogram")
chart:SetYAxisTitle("Frequency")
chart:SetXAxisTitle("DT")

//we might then add this chart to a game.

Inherits from: Libraries.Compute.Statistics.DataFrameChartCreator, Libraries.Compute.Statistics.Inputs.ColumnInput, Libraries.Language.Object, 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

BinWidthIsNumber(boolean flag)

Boolean to see if binwidth is a number or integer, helps with clean x labels Example a bin width of 1 (integer) would produce a label [1-2] and a bin width of 1.0 would produce [1.0-2.0]

Parameters

  • boolean flag

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)

Create(Libraries.Compute.Statistics.DataFrame frame, boolean sort)

This action creates and returns a chart, of any kind, using the parameters in the subclass.

Parameters

Return

Libraries.Interface.Controls.Charts.Chart: A chart object, which can be embedded into a user interface

Example

use Libraries.Compute.Statistics.DataFrame
use Libraries.Compute.Statistics.Charts.BarChartCreator
use Libraries.System.File

//Load a comma separated file
DataFrame frame
frame:Load("Data.csv")

//We might instantiate an object to create a bar chart, setting some properties if we want to
BarChartCreator create
frame:CreateChart(create)

Create(Libraries.Compute.Statistics.DataFrame frame)

Parameters

Return

Libraries.Interface.Controls.Charts.Chart

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)

GetBinWidth()

Obtains what the bin width was.

Return

number:

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:

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:

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

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.

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

SetBinWidth(number binWidthOverride)

Manually changes the bin width.

Parameters

  • number binWidthOverride