Libraries.Compute.Statistics.Charts.BoxPlotCreator Documentation

This class is used to create a box plot of data in a DataFrame. It calculates the median and the lower and upper quartiles, it also finds the maximum and minimum values.

Example Code

use Libraries.Compute.Statistics.DataFrame
use Libraries.Compute.Statistics.Charts.BoxPlotCreator
use Libraries.Interface.Controls.Charts.BoxPlot
use Libraries.Game.Game

class Main is Game
    action Main
        StartGame()
    end

    action CreateGame
        DataFrame frame
        frame:Load("Data/Data.csv")
        BoxPlotCreator creator
        creator:AddColumn(2)
    
        BoxPlot chart = cast(BoxPlot,frame:CreateChart(creator))
        chart:SetPercentageWidth(1)
        chart:SetPercentageHeight(1)
        chart:SetTitle("Sample Title")
        chart:SetXAxisTitle("X-axis Variable")
        chart:SetYAxisTitle("Y-axis Variable")
        Add(chart)
    end
end

Inherits from: Libraries.Compute.Statistics.DataFrameChartCreator, Libraries.Compute.Statistics.Inputs.ColumnInput, Libraries.Compute.Statistics.Calculations.InterQuartileRange, Libraries.Language.Object, Libraries.Compute.Statistics.Inputs.FactorInput, Libraries.Compute.Statistics.DataFrameColumnCalculation

Actions Documentation

Add(Libraries.Language.Types.Integer value)

If the calculation returns true from IsIterable, this is an Integer object that was passed to the calculation. This may be undefined, which indicates that the column did not contain a value at this position in the column.

Parameters

Add(Libraries.Language.Types.Boolean value)

If the calculation returns true from IsIterable, this is a Boolean object that was passed to the calculation. This may be undefined, which indicates that the column did not contain a value at this position in the column.

Parameters

Add(Libraries.Language.Types.Number value)

If the calculation returns true from IsIterable, this is a Number object that was passed to the calculation. This may be undefined, which indicates that the column did not contain a value at this position in the column.

Parameters

Add(Libraries.Language.Types.Text value)

If the calculation returns true from IsIterable, this is a Text object that was passed to the calculation. This may be undefined, which indicates that the column did not contain a value at this position in the column.

Parameters

Add(Libraries.Language.Object value)

If the calculation otherwise has no primitive type, it sends it to the column as a raw object. Columns might use this if they have custom types.

Parameters

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

Calculate(Libraries.Compute.Statistics.DataFrameColumn column)

Parameters

Calculations(Libraries.Compute.Statistics.Columns.NumberColumn column, Libraries.Compute.Vector dataset)

This action returns the five number summary of a dataset as an array, in the order median, lower quartile, upper quartile, smallest, largest. It also excludes outliers in the set as smallest and largest.

Parameters

Return

Libraries.Containers.Array:

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

Empty()

This Calculation can be re-used if the Empty action is called before passing it to another column. Otherwise, it retains its data.

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.

End(Libraries.Compute.Statistics.DataFrameColumn column)

This action is called at the end of a calculation.

Parameters

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)

GetBottomMedian()

Returns the median in the bottom half of the column.

Return

number: the median in the bottom half

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

GetInterQuartileRange()

Returns the interquartile range, which is the top median - the bottom median.

Return

number: the interquartile range.

GetMaximum()

Returns the max value in the data set.

Return

number: the max value

GetMedian()

Returns the median for the column.

Return

number: the median

GetMinimum()

Returns the min value in the data set.

Return

number: the min value

GetSize()

Returns the sample size for the column.

Return

integer: the sample size

GetTopMedian()

Returns the median in the top half of the column.

Return

number: the median in the top half

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.

IsIterable()

Return

boolean

IsNumerical()

If this action returns true, the calculation is numerical, the column must be numerical If this is false, the calculation should be non-numerical, thus the column will not be required to be a numerical column action.

Return

boolean:

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

Start(Libraries.Compute.Statistics.DataFrameColumn column)

Parameters