## 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
e
```

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

## Summary

### Actions Summary Table

Actions | Description |
---|---|

Add(Libraries.Language.Types.Integer value) | If the calculation returns true from IsIterable, this is an Integer object that was passed to the calculation. |

Add(Libraries.Language.Types.Boolean value) | If the calculation returns true from IsIterable, this is a Boolean object that was passed to the calculation. |

Add(Libraries.Language.Types.Number value) | If the calculation returns true from IsIterable, this is a Number object that was passed to the calculation. |

Add(Libraries.Language.Types.Text value) | If the calculation returns true from IsIterable, this is a Text object that was passed to the calculation. |

Add(Libraries.Language.Object value) | If the calculation otherwise has no primitive type, it sends it to the column as a raw object. |

AddColumn(integer column) | This action adds a value to the end of the input. |

Calculate(Libraries.Compute.Statistics.DataFrameColumn column) | |

Calculations(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. |

Compare(Libraries.Language.Object object) | This action compares two object hash codes and returns an integer. |

Create(Libraries.Compute.Statistics.DataFrame frame) | |

Empty() | This Calculation can be re-used if the Empty action is called before passing it to another column. |

EmptyColumns() | This action empty's the list, clearing out all of the items contained within i |

End(Libraries.Compute.Statistics.DataFrameColumn column) | This action is called at the end of a calculatio |

Equals(Libraries.Language.Object object) | This action determines if two objects are equal based on their hash code values. |

GetBottomMedian() | Returns the median in the bottom half of the column. |

GetColumn(integer index) | This action gets the item at a given location in an array. |

GetColumnIterator() | This action gets an iterator for the object and returns that iterator. |

GetColumnSize() | This action gets the size of the array. |

GetHashCode() | This action gets the hash code for an object. |

GetInterQuartileRange() | Returns the interquartile range, which is the top median - the bottom median. |

GetMaximum() | Returns the max value in the data set. |

GetMedian() | Returns the median for the column. |

GetMinimum() | Returns the min value in the data set. |

GetSize() | Returns the sample size for the column. |

GetTopMedian() | Returns the median in the top half of the column. |

GetYTickCount() | This action returns how many scale ticks should be used along the Y axis of the LineChart. |

IsEmptyColumns() | This action returns a boolean value, true if the container is empty and false if it contains any items. |

IsIterable() | |

RemoveColumn(integer column) | This action removes the first occurrence of an item that is found in the Addable object. |

RemoveColumnAt(integer index) | This action removes an item from an indexed object and returns that item. |

SetYTickCount(integer yTicks) | This action sets how many scale ticks should be used along the Y axis of the LineChart. |

Start(Libraries.Compute.Statistics.DataFrameColumn column) |

## 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 colum

#### 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 colum

#### 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 colum

#### 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 colum

#### 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 type

#### Parameters

### AddColumn(integer column)

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

#### Parameters

### Calculate(Libraries.Compute.Statistics.DataFrameColumn column)

#### Parameters

### Calculations(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 larges

#### Parameters

#### Return

### 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

- Libraries.Language.Object: The object to compare to.

#### Return

integer: The Compare result, Smaller, Equal, or Larger.

### 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 dat

### EmptyColumns()

This action empty's the list, clearing out all of the items contained within i

### End(Libraries.Compute.Statistics.DataFrameColumn column)

This action is called at the end of a calculatio

#### Parameters

### 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

- Libraries.Language.Object: The to be compared.

#### Return

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

### GetBottomMedian()

Returns the median in the bottom half of the column.

#### Return

number: the median in the bottom ha

### GetColumn(integer index)

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

#### Parameters

#### Return

integer: The item at the given locatio

### GetColumnIterator()

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

#### Return

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

### GetColumnSize()

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.

### GetInterQuartileRange()

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

#### Return

number: the interquartile rang

### GetMaximum()

Returns the max value in the data set.

#### Return

number: the max val

### GetMedian()

Returns the median for the column.

#### Return

number: the medi

### GetMinimum()

Returns the min value in the data set.

#### Return

number: the min val

### GetSize()

Returns the sample size for the column.

#### Return

integer: the sample si

### GetTopMedian()

Returns the median in the top half of the column.

#### Return

number: the median in the top ha

### GetYTickCount()

This action returns how many scale ticks should be used along the Y axis of the LineChart. By default, this value is 5.

#### Return

integer: The number of ticks along the Y axis of the LineChar

### 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 no

### IsIterable()

#### Return

boolean

### RemoveColumn(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

### RemoveColumnAt(integer index)

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

#### Parameters

### SetYTickCount(integer yTicks)

This action sets how many scale ticks should be used along the Y axis of the LineChart. By default, this value is 5.

#### Parameters

- integer yTicks: How many ticks should be used along the Y axis of the LineChar