R6 class the represents a Calculation Batch

Description

The 'PivotBatch' class represents one combination of data, variables and calculations that are needed when calculating the values of cells in a pivot table.

Format

R6Class object.

Details

The combination of data name and variable names defines a batch. When the batch is calculated, the calculations specified in the batch are evaluated against the specified data, with the data being grouped by the variables specified in the batch. Individual result values can then be retrieved from the batch. See the "Performance" vignette for details.

Active bindings

Methods

Public methods

• PivotBatch$new()

• PivotBatch$isCompatible()

• PivotBatch$addCompatible()

• PivotBatch$getCalculationInternalName()

• PivotBatch$evaluateBatch()

• PivotBatch$getSummaryValueFromBatch()

• PivotBatch$clone()

Method new()

Create a new 'PivotBatch' object.

Usage

PivotBatch$new(
  parentPivot = NULL,
  batchId = 0,
  dataName = NULL,
  variableNames = NULL,
  values = NULL,
  calculationName = NULL,
  calculationGroupName = NULL
)

Arguments

Returns

A new 'PivotBatch' object.

Method isCompatible()

Determine whether a combination of data and variables is compatible with this batch.

Usage

PivotBatch$isCompatible(dataName = NULL, variableNames = NULL)

Arguments

Returns

'TRUE' or 'FALSE'.

Method addCompatible()

Add a new set of values or a new calculation to the batch. with this batch.

Usage

PivotBatch$addCompatible(
  values = NULL,
  calculationName = NULL,
  calculationGroupName = NULL
)

Arguments

Returns

No return value.

Method getCalculationInternalName()

Find the internal name of a calculation in the batch.

Usage

PivotBatch$getCalculationInternalName(
  calculationName = NULL,
  calculationGroupName = NULL
)

Arguments

Returns

The internal name of the calculation in the batch.

Method evaluateBatch()

Carry out grouping and calculations to evaluate the batch.

Usage

PivotBatch$evaluateBatch()

Returns

No return value.

Method getSummaryValueFromBatch()

Retrieve one calculation value from the batch, typically for the value of one cell in a pivot table.

Usage

PivotBatch$getSummaryValueFromBatch(
  filters = NULL,
  calculationName = NULL,
  calculationGroupName = NULL
)

Arguments

Returns

A single calculation value.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotBatch$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by the pivot table.
# It is not intended to be created outside of the pivot table.

R6 class that calculates the values for multiple cells in batches.

Description

The 'PivotBatchCalculator' class calculates the values for multiple cells in the pivot table in one evaluation step (per batch), instead of evaluating every calculation once per pivot table cell.

Format

R6Class object.

Details

Evaluating a set of filters and calculations repetitively for each cell is inefficient and slow. The Batch Calculator executes a much small number of calculations which greatly reduces the CPU time and elapsed time required. See the "Performance" vignette for details.

Active bindings

Methods

Public methods

• PivotBatchCalculator$new()

• PivotBatchCalculator$reset()

• PivotBatchCalculator$checkValidWorkingData()

• PivotBatchCalculator$isFiltersBatchCompatible()

• PivotBatchCalculator$generateBatchesForNamedCalculationEvaluation1()

• PivotBatchCalculator$generateBatchesForNamedCalculationEvaluation2()

• PivotBatchCalculator$generateBatchesForCellEvaluation()

• PivotBatchCalculator$evaluateBatches()

• PivotBatchCalculator$getSummaryValueFromBatch()

• PivotBatchCalculator$clone()

Method new()

Create a new 'PivotBatchCalculator' object.

Usage

PivotBatchCalculator$new(parentPivot = NULL)

Arguments

Returns

A new 'PivotBatchCalculator' object.

Method reset()

Reset the batch calculator, clearing all existing batches.

Usage

PivotBatchCalculator$reset()

Returns

No return value.

Method checkValidWorkingData()

Run some additional checks to see whether the working data is valid. Typically only used in development builds of the package.

Usage

PivotBatchCalculator$checkValidWorkingData(workingData = NULL)

Arguments

Returns

No return value.

Method isFiltersBatchCompatible()

Examines a set of filters to see whether they are compatible with batch evaluation mode. Only filters that specify zero or one value for each variable are compatible with batch evaluation.

Usage

PivotBatchCalculator$isFiltersBatchCompatible(filters = NULL)

Arguments

Details

It is not practical to make batch evaluation work where a filter matches more than one value for a variable. One approach might be to add a derived column where a single value represents the multiple values, however the combination of values could partially overlap with combinations of values in other data groups. Also the value that represents the "combined" value could collide with other existing values in the column. In summary: Sequential mode is slower and more flexible. Batch is faster but stricter. Batch mode works for regular pivot tables (i.e. most cases).

Returns

'TRUE' if the filters are batch compatible, 'FALSE' otherwise.

Method generateBatchesForNamedCalculationEvaluation1()

Generates a new batch or finds a relevant existing batch for a named calculation and single working filters object.

Usage

PivotBatchCalculator$generateBatchesForNamedCalculationEvaluation1(
  dataName = NULL,
  calculationName = NULL,
  calculationGroupName = NULL,
  workingFilters = NULL
)

Arguments

Returns

The name of either the batch that was created or the relevant existing batch.

Method generateBatchesForNamedCalculationEvaluation2()

Generates one or more batches for the named calculations and set of working working data associated with a cell.

Usage

PivotBatchCalculator$generateBatchesForNamedCalculationEvaluation2(
  calculationName = NULL,
  calculationGroupName = NULL,
  workingData = NULL
)

Arguments

Details

A wrapper around 'generateBatchesForNamedCalculationEvaluation1()', which invokes this function as appropriate, depending on whether a calculation if either of type "summary" or type "calculation".

Returns

One or more batch names of either the batches that were created or the relevant existing batches.

Method generateBatchesForCellEvaluation()

Generates the batches for batch evaluation mode.

Usage

PivotBatchCalculator$generateBatchesForCellEvaluation()

Returns

One or more batch names of either the batches that were created or the relevant existing batches.

Method evaluateBatches()

Evaluate each of the batches defined in the batch calculator.

Usage

PivotBatchCalculator$evaluateBatches()

Returns

The number of batches that were evaluated.

Method getSummaryValueFromBatch()

Retrieve one calculation value from one batch, typically for the value of one cell in a pivot table.

Usage

PivotBatchCalculator$getSummaryValueFromBatch(
  batchName = NULL,
  calculationName = NULL,
  calculationGroupName = NULL,
  workingFilters = NULL
)

Arguments

Returns

A single calculation value.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotBatchCalculator$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by the pivot table.
# It is not intended to be created outside of the pivot table.

R6 class that provides summary statistics for batch calculations.

Description

The 'PivotBatchStatistics' class contains a set of summary statistics that track how many calculations are batch compatible/incompatible.

Format

R6Class object.

Active bindings

Methods

Public methods

• PivotBatchStatistics$new()

• PivotBatchStatistics$reset()

• PivotBatchStatistics$incrementNoData()

• PivotBatchStatistics$incrementCompatible()

• PivotBatchStatistics$incrementIncompatible()

• PivotBatchStatistics$clone()

Method new()

Create a new 'PivotBatchStatistics' object.

Usage

PivotBatchStatistics$new(parentPivot = NULL)

Arguments

Returns

A new 'PivotBatchStatistics' object.

Method reset()

Clear the batch statistics.

Usage

PivotBatchStatistics$reset()

Returns

No return value.

Method incrementNoData()

Increment the noData count for a batch.

Usage

PivotBatchStatistics$incrementNoData(
  calculationName = NULL,
  calculationGroupName = NULL
)

Arguments

Returns

No return value.

Method incrementCompatible()

Increment the compatible count for a batch.

Usage

PivotBatchStatistics$incrementCompatible(
  calculationName = NULL,
  calculationGroupName = NULL
)

Arguments

Returns

No return value.

Method incrementIncompatible()

Increment the incompatible count for a batch.

Usage

PivotBatchStatistics$incrementIncompatible(
  calculationName = NULL,
  calculationGroupName = NULL
)

Arguments

Returns

No return value.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotBatchStatistics$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by the pivot table.
# It is not intended to be created outside of the pivot table.

R6 class that defines a calculation.

Description

The 'PivotCalculation' class defines one calculation in a pivot table.

Format

R6Class object.

Active bindings

Methods

Public methods

• PivotCalculation$new()

• PivotCalculation$asList()

• PivotCalculation$asJSON()

• PivotCalculation$asString()

• PivotCalculation$clone()

Method new()

Create a new 'PivotCalculation' object.

Usage

PivotCalculation$new(
  parentPivot,
  calculationName = NULL,
  caption = NULL,
  visible = TRUE,
  displayOrder = NULL,
  filters = NULL,
  format = NULL,
  fmtFuncArgs = NULL,
  dataName = NULL,
  type = "summary",
  valueName = NULL,
  summariseExpression = NULL,
  calculationExpression = NULL,
  calculationFunction = NULL,
  calcFuncArgs = NULL,
  basedOn = NULL,
  noDataValue = NULL,
  noDataCaption = NULL,
  headingBaseStyleName = NULL,
  headingStyleDeclarations = NULL,
  cellBaseStyleName = NULL,
  cellStyleDeclarations = NULL
)

Arguments

Returns

A new 'PivotCalculation' object.

Method asList()

Return the contents of this object as a list for debugging.

Usage

PivotCalculation$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

PivotCalculation$asJSON()

Returns

A JSON representation of various object properties.

Method asString()

Return a representation of this object as a character value.

Usage

PivotCalculation$asString()

Returns

A character summary of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotCalculation$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by the pivot table.
# It is not intended to be created outside of the pivot table.

R6 class that defines a group of calculations.

Description

The 'PivotCalculationGroup' class is a container for multiple 'PivotCalculation' objects. Every pivot table has at least one pivot calculation group and this is sufficient for all regular pivot tables. Additional calculation groups are typically only created for irregular/custom pivot tables. See the "Irregular Layout" vignette for an example.

Format

R6Class object.

Active bindings

Methods

Public methods

• PivotCalculationGroup$new()

• PivotCalculationGroup$isExistingCalculation()

• PivotCalculationGroup$item()

• PivotCalculationGroup$getCalculation()

• PivotCalculationGroup$defineCalculation()

• PivotCalculationGroup$asList()

• PivotCalculationGroup$asJSON()

• PivotCalculationGroup$asString()

• PivotCalculationGroup$clone()

Method new()

Create a new 'PivotCalculationGroup' object.

Usage

PivotCalculationGroup$new(parentPivot, calculationGroupName = NULL)

Arguments

Returns

A new 'PivotCalculationGroup' object.

Method isExistingCalculation()

Check whether a calculation already exists in this calculation group.

Usage

PivotCalculationGroup$isExistingCalculation(calculationName = NULL)

Arguments

Returns

'TRUE' if a calculation with the specified name exists in this calculation group object, 'FALSE' otherwise.

Method item()

Retrieve a calculation by index.

Usage

PivotCalculationGroup$item(index)

Arguments

Returns

The calculation that exists at the specified index.

Method getCalculation()

Retrieve a calculation by name.

Usage

PivotCalculationGroup$getCalculation(calculationName = NULL)

Arguments

Returns

The calculation with the specified name.

Method defineCalculation()

Create a new 'PivotCalculation' object.

Usage

PivotCalculationGroup$defineCalculation(
  calculationName = NULL,
  caption = NULL,
  visible = TRUE,
  displayOrder = NULL,
  filters = NULL,
  format = NULL,
  fmtFuncArgs = NULL,
  dataName = NULL,
  type = "summary",
  valueName = NULL,
  summariseExpression = NULL,
  calculationExpression = NULL,
  calculationFunction = NULL,
  calcFuncArgs = NULL,
  basedOn = NULL,
  noDataValue = NULL,
  noDataCaption = NULL,
  headingBaseStyleName = NULL,
  headingStyleDeclarations = NULL,
  cellBaseStyleName = NULL,
  cellStyleDeclarations = NULL
)

Arguments

Returns

A new 'PivotCalculation' object.

Method asList()

Return the contents of this object as a list for debugging.

Usage

PivotCalculationGroup$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

PivotCalculationGroup$asJSON()

Returns

A JSON representation of various object properties.

Method asString()

Return a representation of this object as a character value.

Usage

PivotCalculationGroup$asString(seperator = ", ")

Arguments

Returns

A character summary of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotCalculationGroup$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by the pivot table.
# It is not intended to be created outside of the pivot table.

R6 class that contains multiple calculation groups.

Description

The 'PivotCalculationGroups' class stores all of the calculation groups for a pivot table. Every pivot table has at least one pivot calculation group and this is sufficient for all regular pivot tables. Additional calculation groups are typically only created for irregular/custom pivot tables. See the "Irregular Layout" vignette for an example.

Format

R6Class object.

Active bindings

Methods

Public methods

• PivotCalculationGroups$new()

• PivotCalculationGroups$isExistingCalculationGroup()

• PivotCalculationGroups$item()

• PivotCalculationGroups$getCalculationGroup()

• PivotCalculationGroups$addCalculationGroup()

• PivotCalculationGroups$asList()

• PivotCalculationGroups$asJSON()

• PivotCalculationGroups$asString()

• PivotCalculationGroups$clone()

Method new()

Create a new 'PivotCalculationGroups' object.

Usage

PivotCalculationGroups$new(parentPivot)

Arguments

Returns

A new 'PivotCalculationGroups' object.

Method isExistingCalculationGroup()

Check if a calculation group exists with the specified name.

Usage

PivotCalculationGroups$isExistingCalculationGroup(calculationGroupName = NULL)

Arguments

Returns

'TRUE' if the calculation group already exists, 'FALSE' otherwise.

Method item()

Retrieve a calculation group by index.

Usage

PivotCalculationGroups$item(index)

Arguments

Returns

The calculation group that exists at the specified index.

Method getCalculationGroup()

Retrieve a calculation group by name.

Usage

PivotCalculationGroups$getCalculationGroup(calculationGroupName = NULL)

Arguments

Returns

The calculation group with the specified name.

Method addCalculationGroup()

Create a new calculation group.

Usage

PivotCalculationGroups$addCalculationGroup(calculationGroupName = NULL)

Arguments

Returns

The new calculation group.

Method asList()

Return the contents of this object as a list for debugging.

Usage

PivotCalculationGroups$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

PivotCalculationGroups$asJSON()

Returns

A JSON representation of various object properties.

Method asString()

Return a representation of this object as a character value.

Usage

PivotCalculationGroups$asString(seperator = ", ")

Arguments

Returns

A character summary of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotCalculationGroups$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by the pivot table.
# It is not intended to be created outside of the pivot table.

R6 class that computes the value of a cell or cells.

Description

The 'PivotCalculator' class has various functions and methods that assist with calculating the value of a cell or cells in a pivot table.

Format

R6Class object.

Details

This class contains all of the logic necessary for evaluating calculations. For batch mode calculations, it makes use of the 'PivotBatchCalculator' class to carry out the calculation batches, then retrieves the results from the relevant batch for each calculation. For sequential mode calculations, this class carries out the calculations. Where a pivot table contains some cells that can be evaluated in batch mode and some that cannot, this class contains the appropriate logic to use the relevant calculation mode in each case, preferring to use batch mode where possible, unless this has been disabled in the pivot table settings. There are many utility methods in this class that are thin wrappers around methods in other classes. This simplifies calling these other methods as well as providing a more unified way to change in the future how these common operations are performed. Custom calculation functions are passed an instance of the 'PivotCalculator' class, thereby also providing the authors of custom calculation functions an easy way for custom calculation functions to carry out common operations.

Active bindings

Methods

Public methods

• PivotCalculator$new()

• PivotCalculator$getDataFrame()

• PivotCalculator$countTotalData()

• PivotCalculator$getTotalDataFrame()

• PivotCalculator$getCalculationGroup()

• PivotCalculator$getCalculation()

• PivotCalculator$generateBatchesForCellEvaluation()

• PivotCalculator$evaluateBatches()

• PivotCalculator$newFilter()

• PivotCalculator$newFilters()

• PivotCalculator$setFilters()

• PivotCalculator$setFilter()

• PivotCalculator$setFilterValues()

• PivotCalculator$getFilteredDataFrame()

• PivotCalculator$getDistinctValues()

• PivotCalculator$formatValue()

• PivotCalculator$getCombinedFilters()

• PivotCalculator$getFiltersForNamedCalculation()

• PivotCalculator$setWorkingData()

• PivotCalculator$evaluateSingleValue()

• PivotCalculator$evaluateSummariseExpression()

• PivotCalculator$evaluateCalculationExpression()

• PivotCalculator$evaluateCalculateFunction()

• PivotCalculator$evaluateNamedCalculationWD()

• PivotCalculator$evaluateNamedCalculation()

• PivotCalculator$evaluateCell()

• PivotCalculator$clone()

Method new()

Create a new 'PivotCalculator' object.

Usage

PivotCalculator$new(parentPivot = NULL)

Arguments

Returns

A new 'PivotCalculator' object.

Method getDataFrame()

Retrieve a data frame that was added to the pivot table.

Usage

PivotCalculator$getDataFrame(dataName = NULL)

Arguments

Returns

The data frame with the specified name.

Method countTotalData()

Count the number of "totals" data frames that have been added to the pivot table.

Usage

PivotCalculator$countTotalData(dataName = NULL)

Arguments

Returns

The number of "totals" data frames associated with the specified name.

Method getTotalDataFrame()

Retrieve a "totals" data frame that was added to the pivot table.

Usage

PivotCalculator$getTotalDataFrame(dataName = NULL, variableNames = NULL)

Arguments

Returns

The "totals" data frame.

Method getCalculationGroup()

Retrieve a calculation group in the pivot table.

Usage

PivotCalculator$getCalculationGroup(calculationGroupName = NULL)

Arguments

Returns

The calculation group with the specified name.

Method getCalculation()

Retrieve a calculation in the pivot table.

Usage

PivotCalculator$getCalculation(
  calculationGroupName = NULL,
  calculationName = NULL
)

Arguments

Returns

The calculation with the specified name in the specified group.

Method generateBatchesForCellEvaluation()

Examine the data groups and cells in a pivot table to generate the structure of the batches in preparation for evaluating the pivot table.

Usage

PivotCalculator$generateBatchesForCellEvaluation()

Returns

The batches that exist in the pivot table.

Method evaluateBatches()

Execute the batch calculations as part of evaluating the pivot table.

Usage

PivotCalculator$evaluateBatches()

Returns

The number of batches that were evaluated.

Method newFilter()

Create a new 'PivotFilter' object associated with the specified data frame column name and column values. The new filter is conceptually of the form 'variableName

Usage

PivotCalculator$newFilter(variableName = NULL, values = NULL)

Arguments

Returns

The new 'PivotFilter' object.

Method newFilters()

Create a new 'PivotFilters' object associated with the specified data frame column name and column values. The new filter is conceptually of the form 'variableName

Usage

PivotCalculator$newFilters(variableName = NULL, values = NULL)

Arguments

Details

A 'PivotFilters' object is a collection of 'PivotFilter' objects, therefore the return value of this method is suitable for use where other filters will subsequently be needed/applied.

Returns

The new 'PivotFilter' object.

Method setFilters()

Combines two 'PivotFilters' objects, e.g. to intersect the filters coming from the row and column headings for a particular cell.

Usage

PivotCalculator$setFilters(
  filters1 = NULL,
  filters2 = NULL,
  action = "replace"
)

Arguments

Returns

A new 'PivotFilters' object.

Method setFilter()

Combines a 'PivotFilters' object with a 'PivotFilter' object.

Usage

PivotCalculator$setFilter(filters = NULL, filter = NULL, action = "replace")

Arguments

Returns

A new 'PivotFilters' object.

Method setFilterValues()

Combines a 'PivotFilters' object with additional filter criteria.

Usage

PivotCalculator$setFilterValues(
  filters = NULL,
  variableName = NULL,
  values = NULL,
  action = "replace"
)

Arguments

Returns

A new 'PivotFilters' object.

Method getFilteredDataFrame()

Apply a set of filters to a data frame and return the filtered results.

Usage

PivotCalculator$getFilteredDataFrame(dataFrame = NULL, filters = NULL)

Arguments

Returns

A filtered data frame.

Method getDistinctValues()

Get the distinct values from a specified column in a data frame.

Usage

PivotCalculator$getDistinctValues(dataFrame = NULL, variableName = NULL)

Arguments

Returns

A vector containing the distinct values.

Method formatValue()

Format a value using a variety of different methods.

Usage

PivotCalculator$formatValue(value = NULL, format = NULL, fmtFuncArgs = NULL)

Arguments

Returns

The formatted value if 'format' is specified, otherwise the 'value' converted to a character value.

Method getCombinedFilters()

Get the working filters for a calculation by combining row-column filters and calculation filters.

Usage

PivotCalculator$getCombinedFilters(
  rowColFilters = NULL,
  calcFilters = NULL,
  cell = NULL
)

Arguments

Returns

A list of filters, element names: calculationFilters and workingFilters. The working filters are the row-column filters combined with the calculation filters.

Method getFiltersForNamedCalculation()

Get the working filters for a named calculation by calling 'getCombinedFilters()' as needed, depending on the calculation type.

Usage

PivotCalculator$getFiltersForNamedCalculation(
  calculationName = NULL,
  calculationGroupName = NULL,
  rowColFilters = NULL,
  cell = NULL
)

Arguments

Returns

A list of filters, where the element names are calculation names. Reminder: Evaluating a named calculation, if 'calc$type="calculation"', can involve computing multiple named calculations, which is why this return value is a list.

Method setWorkingData()

Set the working data filters for a cell in the pivot table.

Usage

PivotCalculator$setWorkingData(cell = NULL)

Arguments

Details

The working data for a cell is a list of 'PivotFilters' objects - one per named calculation. Most cells only relate to one calculation, but calculations of type 'calc$type="calculation"' can relate to multiple calculations, hence the working data is a list where the element name is the calculation name. This method calls 'getFiltersForNamedCalculation()' internally to generate the filters for the working data.

Returns

No return value.

Method evaluateSingleValue()

Get a single value from a data frame, as part of evaluating a calculation where the calculation is of type 'calc$type="value"'.

Usage

PivotCalculator$evaluateSingleValue(
  dataFrame = NULL,
  workingFilters = NULL,
  valueName = NULL,
  format = NULL,
  fmtFuncArgs = NULL,
  noDataValue = NULL,
  noDataCaption = NULL
)

Arguments

Returns

A list containing two elements: rawValue (typically numeric) and formattedValue (typically a character value).

Method evaluateSummariseExpression()

Get a summary value from a data frame, as part of evaluating a calculation where the calculation is of type 'calc$type="summary"'.

Usage

PivotCalculator$evaluateSummariseExpression(
  dataName = NULL,
  dataFrame = NULL,
  workingFilters = NULL,
  batchName = NULL,
  calculationName = NULL,
  calculationGroupName = NULL,
  summaryName = NULL,
  summariseExpression = NULL,
  format = NULL,
  fmtFuncArgs = NULL,
  noDataValue = NULL,
  noDataCaption = NULL
)

Arguments

Details

Where batch evaluation is used, the value is retrieved from the pre-calculated batch, otherwise dplyr/data.table is used to calculate the value (i.e. reverting to sequential evaluation mode which performs calculations cell-by-cell, one cell at a time).

Returns

A list containing two elements: rawValue (typically numeric) and formattedValue (typically a character value).

Method evaluateCalculationExpression()

Evaluates an R expression in order to combine the results of other calculations, as part of evaluating a calculation where the calculation is of type 'calc$type="calculation"'.

Usage

PivotCalculator$evaluateCalculationExpression(
  values = NULL,
  calculationExpression = NULL,
  format = NULL,
  fmtFuncArgs = NULL,
  noDataValue = NULL,
  noDataCaption = NULL
)

Arguments

Details

A calculation, where 'calc$type="calculation"', combines the results of other calculations using a simple R expression.

Returns

A list containing two elements: rawValue (typically numeric) and formattedValue (typically a character value).

Method evaluateCalculateFunction()

Invokes a user-provided custom R function to aggregate data and perform calculations, as part of evaluating a calculation where the calculation is of type 'calc$type="function"'.

Usage

PivotCalculator$evaluateCalculateFunction(
  workingFilters = NULL,
  calculationFunction = NULL,
  calcFuncArgs = NULL,
  format = NULL,
  fmtFuncArgs = NULL,
  baseValues = NULL,
  cell = NULL
)

Arguments

Details

A calculation, where 'calc$type="function"', invokes a user provided R function on a cell-by-cell basis.

Returns

A list containing two elements: rawValue (typically numeric) and formattedValue (typically a character value).

Method evaluateNamedCalculationWD()

Invokes the relevant calculation function based upon the calculation type.

Usage

PivotCalculator$evaluateNamedCalculationWD(
  calculationName = NULL,
  calculationGroupName = NULL,
  workingData = NULL,
  cell = NULL
)

Arguments

Details

This function examines the 'calc$type' property then invokes either 'evaluateSingleValue()', 'evaluateSummariseExpression()', 'evaluateCalculationExpression()' or 'evaluateCalculateFunction()'. Sometimes, more than one of the these functions is invoked, since calculation type "calculation" and "function" can/do make use of values from other calculations, which must be evaluated first.

Returns

A list containing two elements: rawValue (typically numeric) and formattedValue (typically a character value).

Method evaluateNamedCalculation()

Invokes the relevant calculation function based upon the calculation type.

Usage

PivotCalculator$evaluateNamedCalculation(
  calculationName = NULL,
  calculationGroupName = NULL,
  rowColFilters = NULL
)

Arguments

Details

This function is a higher-level wrapper around 'evaluateNamedCalculationWD()'. This version incorporates logic to convert the filters from the row and column data groups into the working data filters, then calls 'evaluateNamedCalculationWD()'. This version has no suffix in the name, since this is the version users are more likely to invoke, e.g. from within a custom calculation function.

Returns

A list containing two elements: rawValue (typically numeric) and formattedValue (typically a character value).

Method evaluateCell()

Evaluate calculations to compute the value of a cell in a pivot table.

Usage

PivotCalculator$evaluateCell(cell = NULL)

Arguments

Returns

A list containing two elements: rawValue (typically numeric) and formattedValue (typically a character value).

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotCalculator$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by the pivot table.
# It is not intended to be created outside of the pivot table.

R6 class that represents a cell in a pivot table.

Description

The 'PivotCell' class represents a cell in the body of a pivot table (i.e. not a row/column heading, rather a cell typically containing a numerical value).

Format

R6Class object.

Active bindings

Methods

Public methods

• PivotCell$new()

• PivotCell$setStyling()

• PivotCell$getCopy()

• PivotCell$asList()

• PivotCell$asJSON()

• PivotCell$clone()

Method new()

Create a new 'PivotCell' object.

Usage

PivotCell$new(
  parentPivot,
  rowNumber = NULL,
  columnNumber = NULL,
  calculationName = NULL,
  calculationGroupName = NULL,
  isEmpty = FALSE,
  rowFilters = NULL,
  columnFilters = NULL,
  rowColFilters = NULL,
  rowLeafGroup = NULL,
  columnLeafGroup = NULL
)

Arguments

Returns

A new 'PivotCell' object.

Method setStyling()

An internal method used to set style declarations on the cell. Using 'pt$setStyling(cells=x)' is preferred for users.

Usage

PivotCell$setStyling(styleDeclarations = NULL)

Arguments

Returns

No return value.

Method getCopy()

Non-functional legacy method soon to be removed.

Usage

PivotCell$getCopy()

Returns

Returns an empty list.

Method asList()

Return the contents of this object as a list for debugging.

Usage

PivotCell$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

PivotCell$asJSON()

Returns

A JSON representation of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotCell$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by the pivot table.
# It is not intended to be created outside of the pivot table.

R6 class that contains the cells in a pivot table.

Description

The 'PivotCells' class contains all of the 'PivotCell' instances that comprise the body of a pivot table.

Format

R6Class object.

Active bindings

Methods

Public methods

• PivotCells$new()

• PivotCells$reset()

• PivotCells$getColumnGroup()

• PivotCells$getRowGroup()

• PivotCells$setGroups()

• PivotCells$getCell()

• PivotCells$setCell()

• PivotCells$getCells()

• PivotCells$findCells()

• PivotCells$findGroupColumnNumbers()

• PivotCells$findGroupRowNumbers()

• PivotCells$getColumnWidths()

• PivotCells$removeColumn()

• PivotCells$removeColumns()

• PivotCells$removeRow()

• PivotCells$removeRows()

• PivotCells$asMatrix()

• PivotCells$asList()

• PivotCells$asJSON()

• PivotCells$clone()

Method new()

Create a new 'PivotCells' object.

Usage

PivotCells$new(parentPivot = NULL)

Arguments

Returns

A new 'PivotCells' object.

Method reset()

Remove all cells from the pivot table and reset row and column counts back to zero.

Usage

PivotCells$reset()

Returns

No return value.

Method getColumnGroup()

Get the leaf-level data group that is associated with a specific column or columns in the pivot table.

Usage

PivotCells$getColumnGroup(c = NULL)

Arguments

Returns

A 'PivotDataGroup' that is associated with the specified column.

Method getRowGroup()

Get the leaf-level data group that is associated with a specific row or rows in the pivot table.

Usage

PivotCells$getRowGroup(r = NULL)

Arguments

Returns

A 'PivotDataGroup' that is associated with the specified row

Method setGroups()

An internal method used when building the cell structure of the pivot table.

Usage

PivotCells$setGroups(rowGroups = NULL, columnGroups = NULL)

Arguments

Returns

No return value.

Method getCell()

Get the cell at the specified row and column coordinates in the pivot table.

Usage

PivotCells$getCell(r = NULL, c = NULL)

Arguments

Details

The row and column numbers refer only to the cells in the body of the pivot table, i.e. row and column headings are excluded, e.g. row 1 is the first row of cells underneath the column headings.

Returns

A 'PivotCell' object representing the cell.

Method setCell()

Set the cell at the specified row and column coordinates in the pivot table.

Usage

PivotCells$setCell(r, c, cell)

Arguments

Details

This method is intended for internal package use only, used when building # the cell structure. The row and column numbers refer only to the cells in the body of the pivot table, i.e. row and column headings are excluded, e.g. row 1 is the first row of cells underneath the column headings.

Returns

No return value.

Method getCells()

Retrieve cells by a combination of row and/or column numbers. See the "Finding and Formatting" vignette for graphical examples.

Usage

PivotCells$getCells(
  specifyCellsAsList = TRUE,
  rowNumbers = NULL,
  columnNumbers = NULL,
  cellCoordinates = NULL,
  excludeEmptyCells = FALSE,
  groups = NULL,
  rowGroups = NULL,
  columnGroups = NULL,
  matchMode = "simple"
)

Arguments

Details

When 'specifyCellsAsList=TRUE' (the default):
Get one or more rows by specifying the row numbers as a vector as the rowNumbers argument and leaving the columnNumbers argument set to the default value of 'NULL', or
Get one or more columns by specifying the column numbers as a vector as the columnNumbers argument and leaving the rowNumbers argument set to the default value of 'NULL', or
Get one or more individual cells by specifying the cellCoordinates argument as a list of vectors of length 2, where each element in the list is the row and column number of one cell,
e.g. 'list(c(1, 2), c(3, 4))' specifies two cells, the first located at row 1, column 2 and the second located at row 3, column 4.
When 'specifyCellsAsList=FALSE':
Get one or more rows by specifying the row numbers as a vector as the rowNumbers argument and leaving the columnNumbers argument set to the default value of 'NULL', or
Get one or more columns by specifying the column numbers as a vector as the columnNumbers argument and leaving the rowNumbers argument set to the default value of 'NULL', or
Get one or more cells by specifying the row and column numbers as vectors for the rowNumbers and columnNumbers arguments, or
a mixture of the above, where for entire rows/columns the element in the other vector is set to 'NA', e.g. to retrieve whole rows, specify the row numbers as the rowNumbers but set the corresponding elements in the columnNumbers vector to 'NA'.

Returns

A list of 'PivotCell' objects.

Method findCells()

Find cells matching specified criteria. See the "Finding and Formatting" vignette for graphical examples.

Usage

PivotCells$findCells(
  variableNames = NULL,
  variableValues = NULL,
  totals = "include",
  calculationNames = NULL,
  minValue = NULL,
  maxValue = NULL,
  exactValues = NULL,
  valueRanges = NULL,
  includeNull = TRUE,
  includeNA = TRUE,
  emptyCells = "include",
  outlineCells = "exclude",
  rowNumbers = NULL,
  columnNumbers = NULL,
  cellCoordinates = NULL,
  groups = NULL,
  rowGroups = NULL,
  columnGroups = NULL,
  rowColumnMatchMode = "simple",
  cells = NULL,
  lowN = NULL,
  highN = NULL
)

Arguments

Returns

A list of 'PivotCell' objects.

Method findGroupColumnNumbers()

Find the column numbers associated with a specific data group or groups.

Usage

PivotCells$findGroupColumnNumbers(group = NULL, collapse = FALSE)

Arguments

Details

If 'group' is a list: If 'collapse' is 'FALSE', then a list of vectors is returned, if 'collapse' is 'TRUE', then a single combined vector is returned.

Returns

Either a vector of column numbers related to the single specified group or a list of vectors containing column numbers related to the specified groups.

Method findGroupRowNumbers()

Find the row numbers associated with a specific data group or groups.

Usage

PivotCells$findGroupRowNumbers(group = NULL, collapse = FALSE)

Arguments

Details

If 'group' is a list: If 'collapse' is 'FALSE', then a list of vectors is returned, if 'collapse' is 'TRUE', then a single combined vector is returned.

Returns

Either a vector of row numbers related to the single specified group or a list of vectors containing row numbers related to the specified groups.

Method getColumnWidths()

Retrieve the width (in characters) of the longest value in each column.

Usage

PivotCells$getColumnWidths()

Returns

A vector containing the length of the longest value in each column.

Method removeColumn()

Remove a column from the pivot table.

Usage

PivotCells$removeColumn(c = NULL, renumberGroups = TRUE)

Arguments

Details

This method removes both the related column group and cells.

Returns

No return value.

Method removeColumns()

Remove multiple column from the pivot table.

Usage

PivotCells$removeColumns(columnNumbers = NULL, renumberGroups = TRUE)

Arguments

Details

This method removes both the related column groups and cells.

Returns

No return value.

Method removeRow()

Remove a row from the pivot table.

Usage

PivotCells$removeRow(r = NULL, renumberGroups = TRUE)

Arguments

Details

This method removes both the related row group and cells.

Returns

No return value.

Method removeRows()

Remove multiple rows from the pivot table.

Usage

PivotCells$removeRows(rowNumbers = NULL, renumberGroups = TRUE)

Arguments

Details

This method removes both the related row groups and cells.

Returns

No return value.

Method asMatrix()

Get a matrix containing all of the values from the body of the pivot table.

Usage

PivotCells$asMatrix(rawValue = TRUE)

Arguments

Returns

A 'matrix' containing the values from the body of the pivot table.

Method asList()

Return the contents of this object as a list for debugging.

Usage

PivotCells$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

PivotCells$asJSON()

Returns

A JSON representation of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotCells$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by the pivot table.
# It is not intended to be created outside of the pivot table.

R6 class that contains named data frames and associated totals.

Description

The PivotData class stores all of the data frames associated with a pivot table. Each data frame can have a set of associated "totals" data frames, which are used to enable the "value" calculation type.

Format

R6Class object.

Active bindings

Methods

Public methods

• PivotData$new()

• PivotData$addData()

• PivotData$getData()

• PivotData$isKnownData()

• PivotData$addTotalData()

• PivotData$countTotalData()

• PivotData$getTotalData()

• PivotData$asList()

• PivotData$asJSON()

• PivotData$clone()

Method new()

Create a new 'PivotData' object.

Usage

PivotData$new(parentPivot = NULL)

Arguments

Returns

A new 'PivotData' object.

Method addData()

Add a data frame to the pivot table, specifying a name that can be used later to easily retrieve it or refer to it.

Usage

PivotData$addData(dataFrame = NULL, dataName = NULL)

Arguments

Returns

No return value.

Method getData()

Retrieve the data frame with the specified name.

Usage

PivotData$getData(dataName = NULL)

Arguments

Returns

A data frame.

Method isKnownData()

Check if a data frame exists with the specified name.

Usage

PivotData$isKnownData(dataName = NULL)

Arguments

Returns

'TRUE' if a data frame exists with the specified name, 'FALSE' otherwise.

Method addTotalData()

Add pre-calculated totals/aggregate data to the pivot table.

Usage

PivotData$addTotalData(dataFrame = NULL, dataName = NULL, variableNames = NULL)

Arguments

Returns

No return value.

Method countTotalData()

Count the number of data frames containing total/aggregate data that exist in the pivot table associated with a specific named data frame.

Usage

PivotData$countTotalData(dataName = NULL)

Arguments

Returns

The number of total/aggregate data frames that exist in the pivot table associated with the specified data frame name.

Method getTotalData()

Retrieve pre-calculated totals/aggregate data from the pivot table.

Usage

PivotData$getTotalData(dataName = NULL, variableNames = NULL)

Arguments

Returns

A data frame.

Method asList()

Return the contents of this object as a list for debugging.

Usage

PivotData$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

PivotData$asJSON()

Returns

A JSON representation of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotData$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by the pivot table.
# It is not intended to be created outside of the pivot table.

R6 class that defines a row or column data group.

Description

The 'PivotDataGroup' class represents one row or column heading in a pivot table. Data groups exist in a hierarchy and have a parent-child relationship, i.e. each 'PivotDataGroup' instance can have one or more child data groups.

Format

R6Class object.

Active bindings

Methods

Public methods

• PivotDataGroup$new()

• PivotDataGroup$getLevelNumber()

• PivotDataGroup$getAncestorGroups()

• PivotDataGroup$getDescendantGroups()

• PivotDataGroup$getLeafGroups()

• PivotDataGroup$getLevelCount()

• PivotDataGroup$getLevelGroups()

• PivotDataGroup$getRelatedOutlineGroups()

• PivotDataGroup$getChildIndex()

• PivotDataGroup$findChildIndex()

• PivotDataGroup$addChildGroup()

• PivotDataGroup$removeChildGroup()

• PivotDataGroup$removeGroup()

• PivotDataGroup$addDataGroups()

• PivotDataGroup$sortDataGroups()

• PivotDataGroup$addCalculationGroups()

• PivotDataGroup$normaliseDataGroup()

• PivotDataGroup$getNetFilters()

• PivotDataGroup$getNetCalculationName()

• PivotDataGroup$isFindMatch()

• PivotDataGroup$findDataGroups()

• PivotDataGroup$setStyling()

• PivotDataGroup$clearSortGroups()

• PivotDataGroup$addSortGroupBefore()

• PivotDataGroup$addSortGroupAfter()

• PivotDataGroup$asList()

• PivotDataGroup$asJSON()

• PivotDataGroup$clone()

Method new()

Create a new 'PivotDataGroup' object.

Usage

PivotDataGroup$new(
  parentGroup = NULL,
  parentPivot = NULL,
  rowOrColumn = NULL,
  doNotExpand = FALSE,
  isEmpty = FALSE,
  isOutline = FALSE,
  styleAsOutline = FALSE,
  captionTemplate = "{value}",
  caption = NULL,
  isTotal = FALSE,
  isLevelSubTotal = FALSE,
  isLevelTotal = FALSE,
  variableName = NULL,
  filterType = "ALL",
  values = NULL,
  calculationGroupName = NULL,
  calculationName = NULL,
  baseStyleName = NULL,
  styleDeclarations = NULL,
  mergeEmptySpace = NULL,
  cellBaseStyleName = NULL,
  cellStyleDeclarations = NULL,
  sortAnchor = NULL,
  outlineLinkedGroupId = NULL
)

Arguments

Returns

A new 'PivotDataGroup' object.

Method getLevelNumber()

Retrieve the level number in the hierarchy that the current data group exists at.

Usage

PivotDataGroup$getLevelNumber()

Returns

An integer value specifying the level number where the data group exists.

Method getAncestorGroups()

Get all of the data groups above the current data group in the parent-child data group hierarchy.

Usage

PivotDataGroup$getAncestorGroups(ancestors = NULL, includeCurrentGroup = FALSE)

Arguments

Returns

A list of data groups, where element 1 is the parent of the current group, element 2 is the grandparent of the current group, etc.

Method getDescendantGroups()

Get all of the data groups below the current data group in the parent-child data group hierarchy.

Usage

PivotDataGroup$getDescendantGroups(
  descendants = NULL,
  includeCurrentGroup = FALSE
)

Arguments

Returns

A list of descendant data groups.

Method getLeafGroups()

Get all of the data groups below the current data group in the parent-child data group hierarchy.

Usage

PivotDataGroup$getLeafGroups(leafGroups = NULL)

Arguments

Returns

A list of leaf-level data groups.

Method getLevelCount()

Count the number of levels in the data group hierarchy.

Usage

PivotDataGroup$getLevelCount(includeCurrentLevel = FALSE)

Arguments

Returns

The maximum number of levels in the hierarchy.

Method getLevelGroups()

Retrieve all of the data groups at a specific level in the data group hierarchy.

Usage

PivotDataGroup$getLevelGroups(level = NULL, levelGroups = NULL)

Arguments

Returns

A list of data groups at the specified level in the hierarchy.

Method getRelatedOutlineGroups()

Retrieve the a list of the typically two or three related data groups that were created as one outlined group.

Usage

PivotDataGroup$getRelatedOutlineGroups(group = NULL)

Arguments

Returns

A list of related outline data groups.

Method getChildIndex()

Get the index of a child group (or groups) in the current groups list of child groups.

Usage

PivotDataGroup$getChildIndex(childGroup = NULL)

Arguments

Returns

An integer vector.

Method findChildIndex()

Find the index of a child group (or groups) corresponding to the specified instance id(s) in the current groups list of child groups.

Usage

PivotDataGroup$findChildIndex(childGroupInstanceId = NULL)

Arguments

Returns

An integer vector.

Method addChildGroup()

Add a new data group as a child of the current data group. The new group is added as the last child unless an index is specified.

Usage

PivotDataGroup$addChildGroup(
  variableName = NULL,
  filterType = "ALL",
  values = NULL,
  doNotExpand = FALSE,
  isEmpty = FALSE,
  isOutline = FALSE,
  styleAsOutline = FALSE,
  captionTemplate = "{value}",
  caption = NULL,
  isTotal = FALSE,
  isLevelSubTotal = FALSE,
  isLevelTotal = FALSE,
  calculationGroupName = NULL,
  calculationName = NULL,
  baseStyleName = NULL,
  styleDeclarations = NULL,
  insertAtIndex = NULL,
  insertBeforeGroup = NULL,
  insertAfterGroup = NULL,
  mergeEmptySpace = NULL,
  cellBaseStyleName = NULL,
  cellStyleDeclarations = NULL,
  sortAnchor = NULL,
  outlineLinkedGroupId = NULL,
  resetCells = TRUE
)

Arguments

Returns

The new 'PivotDataGroup' object.

Method removeChildGroup()

Remove a data group that is a child of the current data group.

Usage

PivotDataGroup$removeChildGroup(index = NULL, group = NULL, resetCells = TRUE)

Arguments

Returns

No return value.

Method removeGroup()

Remove the current data group.

Usage

PivotDataGroup$removeGroup(
  removeAncestorsIfNoRemainingChildren = FALSE,
  removedRelatedOutlineGroups = FALSE,
  resetCells = TRUE
)

Arguments

Returns

No return value.

Method addDataGroups()

Add multiple new data groups based on the distinct values in a data frame column or using explicitly specified data values. See the "Irregular Layout" vignette for example usage.

Usage

PivotDataGroup$addDataGroups(
  variableName = NULL,
  atLevel = NULL,
  fromData = TRUE,
  dataName = NULL,
  dataSortOrder = "asc",
  customSortOrder = NULL,
  caption = "{value}",
  dataFormat = NULL,
  dataFmtFuncArgs = NULL,
  onlyCombinationsThatExist = TRUE,
  explicitListOfValues = NULL,
  calculationGroupName = NULL,
  expandExistingTotals = FALSE,
  addTotal = TRUE,
  visualTotals = FALSE,
  totalPosition = "after",
  totalCaption = "Total",
  onlyAddGroupIf = NULL,
  preGroupData = TRUE,
  baseStyleName = NULL,
  styleDeclarations = NULL,
  outlineBefore = NULL,
  outlineAfter = NULL,
  outlineTotal = FALSE,
  onlyAddOutlineChildGroupIf = NULL
)

Arguments

Details

There are broadly three different ways to call 'addDataGroups()':
(1) dataName=name, fromData=TRUE, onlyCombinationsThatExist=TRUE - which considers the ancestors of each existing data group to generate only those combinations of values that exist in the data frame.
(2) dataName=name, fromData=TRUE, onlyCombinationsThatExist=FALSE - which ignores the ancestors of each existing data group and simply adds every distinct value of the specified variable under every existing data group, which can result in combinations of values in the pivot table that don't exist in the data frame (i.e. blank rows/columns in the pivot table).
(3) fromData=FALSE, explicitListOfValues=list(...) - simply adds every value from the specified list under every existing data group.

Returns

A list of new 'PivotDataGroup' objects that have been added.

Method sortDataGroups()

Sort data groups either by the data group data value, caption, a custom order or based on calculation result values.

Usage

PivotDataGroup$sortDataGroups(
  levelNumber = 1,
  orderBy = "calculation",
  customOrder = NULL,
  sortOrder = "desc",
  calculationGroupName = "default",
  calculationName = NULL,
  fromIndex = NULL,
  toIndex = NULL,
  resetCells = TRUE
)

Arguments

Returns

No return value.

Method addCalculationGroups()

Add multiple new groups to the data group hierarchy to represent calculations.

Usage

PivotDataGroup$addCalculationGroups(
  calculationGroupName = NULL,
  atLevel = NULL,
  outlineBefore = NULL,
  outlineAfter = NULL,
  resetCells = TRUE
)

Arguments

Returns

A list of new 'PivotDataGroup' objects that have been added.

Method normaliseDataGroup()

Normalise the data group hierarchy so that all branches have the same number of levels - accomplished by adding empty child data groups where needed.

Usage

PivotDataGroup$normaliseDataGroup(resetCells = TRUE)

Arguments

Returns

A list of new 'PivotDataGroup' objects that have been added.

Method getNetFilters()

Get a 'PivotFilters' object that contains the filters applied in this data group and all of its ancestors in the data group hierarchy.

Usage

PivotDataGroup$getNetFilters()

Returns

A 'PivotFilters' object.

Method getNetCalculationName()

Get the calculation name set in this data group or its nearest ancestor.

Usage

PivotDataGroup$getNetCalculationName()

Returns

The name of a calculation.

Method isFindMatch()

Test whether this data group matches specified criteria.

Usage

PivotDataGroup$isFindMatch(
  matchMode = "simple",
  variableNames = NULL,
  variableValues = NULL,
  totals = "include",
  calculationNames = NULL,
  atLevels = NULL,
  minChildCount = NULL,
  maxChildCount = NULL,
  emptyGroups = "exclude",
  outlineGroups = "exclude",
  outlineLinkedGroupExists = NULL
)

Arguments

Returns

'TRUE' if this group matches the specified criteria, 'FALSE' otherwise.

Method findDataGroups()

Find data groups that match specified criteria.

Usage

PivotDataGroup$findDataGroups(
  matchMode = "simple",
  variableNames = NULL,
  variableValues = NULL,
  totals = "include",
  calculationNames = NULL,
  atLevels = NULL,
  minChildCount = NULL,
  maxChildCount = NULL,
  emptyGroups = "exclude",
  outlineGroups = "exclude",
  outlineLinkedGroupExists = NULL,
  includeDescendantGroups = FALSE,
  includeCurrentGroup = TRUE
)

Arguments

Returns

A list of data groups matching the specified criteria.

Method setStyling()

An internal method used to set style declarations on the data group. Using 'pt$setStyling(cells=x)' is preferred for users.

Usage

PivotDataGroup$setStyling(styleDeclarations = NULL)

Arguments

Returns

No return value.

Method clearSortGroups()

An internal method that clears state data used during sorting operations.

Usage

PivotDataGroup$clearSortGroups()

Returns

No return value.

Method addSortGroupBefore()

An internal method used during sorting operations.

Usage

PivotDataGroup$addSortGroupBefore(grp)

Arguments

Returns

No return value.

Method addSortGroupAfter()

An internal method used during sorting operations.

Usage

PivotDataGroup$addSortGroupAfter(grp)

Arguments

Returns

No return value.

Method asList()

Return the contents of this object as a list for debugging.

Usage

PivotDataGroup$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

PivotDataGroup$asJSON()

Returns

A JSON representation of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotDataGroup$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by the pivot table.
# It is not intended to be created outside of the pivot table.

R6 class that defines a filter condition.

Description

The 'PivotFilter' class represents a single filter condition.

Format

R6Class object.

Details

The filter condition represented by a 'PivotFilter' instance relates to one data frame variable/column and is of the form [ColumnName] IN c(Value1, Value2, Value3, ...). Often in a pivot table, each filter specifies only one data value, as typically each distinct data value exists in a separate row or column. The 'PivotFilter' class contains methods to perform set based operations on filter values when combining filters.

Active bindings

Methods

Public methods

• PivotFilter$new()

• PivotFilter$intersect()

• PivotFilter$union()

• PivotFilter$replace()

• PivotFilter$getCopy()

• PivotFilter$asList()

• PivotFilter$asJSON()

• PivotFilter$asString()

• PivotFilter$clone()

Method new()

Create a new 'PivotFilter' object.

Usage

PivotFilter$new(parentPivot, variableName = NULL, type = "ALL", values = NULL)

Arguments

Returns

A new 'PivotFilter' object.

Method intersect()

Updates this filter by intersecting the values in this filter with the values from another 'PivotFilter' object.

Usage

PivotFilter$intersect(filter)

Arguments

Returns

No return value.

Method union()

Updates this filter by unioning the values in this filter with the values from another 'PivotFilter' object.

Usage

PivotFilter$union(filter)

Arguments

Returns

No return value.

Method replace()

Updates this filter by replacing the values in this filter with the values from another 'PivotFilter' object.

Usage

PivotFilter$replace(filter)

Arguments

Returns

No return value.

Method getCopy()

Create a copy of this 'PivotFilter' object.

Usage

PivotFilter$getCopy()

Returns

A copy of this 'PivotFilter' object.

Method asList()

Return the contents of this object as a list for debugging.

Usage

PivotFilter$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

PivotFilter$asJSON()

Returns

A JSON representation of various object properties.

Method asString()

Return a representation of this object as a character value.

Usage

PivotFilter$asString(includeVariableName = TRUE, seperator = " ")

Arguments

Returns

A character summary of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotFilter$clone(deep = FALSE)

Arguments

Examples

pt <- PivotTable$new()
# ...
PivotFilter$new(pt, variableName="Country", values="England")

R6 class that defines a set of filter overrides.

Description

The 'PivotFilterOverrides' class contains multiple PivotFilter objects that can be used later to override a set of filters, e.g. in a pivot table calculation.

Format

R6Class object.

Details

Each cell in a pivot table has context (i.e. filters) coming from the row and column groups that are applicable to the cell. The 'PivotFilterOverrides' class contains several different ways of changing this filter criteria as part of a calculation. In most use cases, only one of the available approaches will be used.

Active bindings

Methods

Public methods

• PivotFilterOverrides$new()

• PivotFilterOverrides$add()

• PivotFilterOverrides$apply()

• PivotFilterOverrides$asList()

• PivotFilterOverrides$asJSON()

• PivotFilterOverrides$asString()

• PivotFilterOverrides$clone()

Method new()

Create a new 'PivotFilterOverrides' object.

Usage

PivotFilterOverrides$new(
  parentPivot = NULL,
  removeAllFilters = FALSE,
  keepOnlyFiltersFor = NULL,
  removeFiltersFor = NULL,
  overrideFunction = NULL,
  filter = NULL,
  variableName = NULL,
  type = "ALL",
  values = NULL,
  action = "replace"
)

Arguments

Returns

A new 'PivotFilterOverrides' object.

Method add()

Add additional filter criteria into this 'PivotFilterOverrides' object. Either 'filter' is specified, or 'variableName', 'type' and 'values' are specified.

Usage

PivotFilterOverrides$add(
  filter = NULL,
  variableName = NULL,
  type = "ALL",
  values = NULL,
  action = "replace"
)

Arguments

Returns

No return value.

Method apply()

Apply the filter overrides to an existing 'PivotFilters' object.

Usage

PivotFilterOverrides$apply(filters = NULL, cell = NULL)

Arguments

Returns

No return value.

Method asList()

Return the contents of this object as a list for debugging.

Usage

PivotFilterOverrides$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

PivotFilterOverrides$asJSON()

Returns

A JSON representation of various object properties.

Method asString()

Return a representation of this object as a character value.

Usage

PivotFilterOverrides$asString(includeVariableName = TRUE, seperator = ", ")

Arguments

Returns

A character summary of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotFilterOverrides$clone(deep = FALSE)

Arguments

Examples

pt <- PivotTable$new()
# ...
# PivotFilterOverrides constructor allows a filter to be defined
# e.g. to enable %of row or column type calculations
filterOverrides <- PivotFilterOverrides$new(pt, keepOnlyFiltersFor="Volume")
# Alternatively/in addition, create a new filter
filter <- PivotFilter$new(pt, variableName="Country", values="England")
# Add the filter to the set of overrides
filterOverrides$add(filter=filter, action="replace")

R6 class that defines a set of filter conditions.

Description

The 'PivotFilters' class allows multiple filter conditions relating to different data frame columns to be combined, i.e. a 'PivotFilters' object typically contains multiple PivotFilter objects.

Format

R6Class object.

Details

As well as acting as a container for multiple filter conditions, the 'PivotFilters' class also contains logic for combining filter. The 'action' parameter in many of the methods controls how two filters are combined.
Most common cases:
(1) When working out the rowColFilters for each pivot table cell, the filters from the row and column leaf groups are combined using 'action="intersect"'.
(2) When combining the rowColFilters with calculation filters the action could be any of (in order of most typical) "intersect", "replace" or "union".
"intersect" would apply additional restrictions, e.g. see the example in the Calculations vignette that has a measure for weekend trains only.
"replace" would apply when doing things like percentage of row total calculations - again, see example in the calculations vignette
"union" is probably much less likely (hard to envisage many situations when that would be needed).
(3) In custom calculation functions, the action could be any of "intersect", "replace" or "union".
NOTE: 'pivottabler' does not allow complex conditions to be built up, such as ((A=X) or (B=Y)) and (C=2) since there is complex precedence involved and conditions like this are not typical of pivot tables. If they were really needed, a workaround would be to use a custom calculation function and include this logic in that function.
See Appendix 2 vignette for many more complex calculation details.

Active bindings

Methods

Public methods

• PivotFilters$new()

• PivotFilters$clearFilters()

• PivotFilters$keepOnlyFiltersFor()

• PivotFilters$removeFiltersFor()

• PivotFilters$getFilter()

• PivotFilters$isFilterMatch()

• PivotFilters$setFilters()

• PivotFilters$setFilter()

• PivotFilters$setFilterValues()

• PivotFilters$addFilter()

• PivotFilters$getFilteredDataFrame()

• PivotFilters$getCopy()

• PivotFilters$asList()

• PivotFilters$asJSON()

• PivotFilters$asString()

• PivotFilters$clone()

Method new()

Create a new 'PivotFilters' object, optionally adding a filter.

Usage

PivotFilters$new(
  parentPivot = NULL,
  variableName = NULL,
  type = "ALL",
  values = NULL
)

Arguments

Returns

A new 'PivotFilters' object.

Method clearFilters()

Remove all filters from this 'PivotFilters' object.

Usage

PivotFilters$clearFilters()

Returns

No return value.

Method keepOnlyFiltersFor()

Remove the filters for all variables except those specified.

Usage

PivotFilters$keepOnlyFiltersFor(variableNames = NULL)

Arguments

Returns

No return value.

Method removeFiltersFor()

Remove the filters for the specified variables.

Usage

PivotFilters$removeFiltersFor(variableNames = NULL)

Arguments

Returns

No return value.

Method getFilter()

Find a filter with the specified variable name.

Usage

PivotFilters$getFilter(variableName = NULL)

Arguments

Returns

A 'PivotFilter' object that filters on the specified variable.

Method isFilterMatch()

Tests whether this 'PivotFilters' object matches specified criteria.

Usage

PivotFilters$isFilterMatch(
  matchMode = "simple",
  variableNames = NULL,
  variableValues = NULL
)

Arguments

Returns

'TRUE' if this filters object matches the specified criteria, 'FALSE' otherwise.

Method setFilters()

Update the value of this 'PivotFilters' object with the filters from the specified 'PivotFilters' object, either intersecting, replacing or unioning the filter criteria.

Usage

PivotFilters$setFilters(filters = NULL, action = "replace")

Arguments

Returns

No return value.

Method setFilter()

Update the value of this 'PivotFilters' object with the filters from the specified 'PivotFilter' object, either intersecting, replacing or unioning the filter criteria.

Usage

PivotFilters$setFilter(filter = NULL, action = "replace")

Arguments

Returns

No return value.

Method setFilterValues()

Update the value of this 'PivotFilters' object with additional filter criteria, either intersecting, replacing or unioning the filter criteria.

Usage

PivotFilters$setFilterValues(
  variableName = NULL,
  type = "ALL",
  values = NULL,
  action = "replace"
)

Arguments

Returns

No return value.

Method addFilter()

Add a new 'PivotFilter' object to the filter list in this 'PivotFilters' object.

Usage

PivotFilters$addFilter(filter = NULL)

Arguments

Returns

No return value.

Method getFilteredDataFrame()

Filters the specified data frame using the filters defined in this 'PivotFilters' object and returns the results as another data frame.

Usage

PivotFilters$getFilteredDataFrame(dataFrame = NULL)

Arguments

Returns

A data frame filtered according to the criteria in this 'PivotFilters' object.

Method getCopy()

Create a copy of this 'PivotFilters' object.

Usage

PivotFilters$getCopy()

Returns

A copy of this 'PivotFilters' object.

Method asList()

Return the contents of this object as a list for debugging.

Usage

PivotFilters$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

PivotFilters$asJSON()

Returns

A JSON representation of various object properties.

Method asString()

Return a representation of this object as a character value.

Usage

PivotFilters$asString(includeVariableName = TRUE, seperator = ", ")

Arguments

Returns

A character summary of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotFilters$clone(deep = FALSE)

Arguments

Examples

pt <- PivotTable$new()
# ...
# PivotFilters constructor allows a filter to be defined
filters <- PivotFilters$new(pt, variableName="Year", values=2017)
# Create a new filter
filter <- PivotFilter$new(pt, variableName="Country", values="England")
# Combine the filters
filters$setFilter(filter)
# filters now contains criteria for both Year and Country
# Now add another filter, this time via an alternative method
filters$setFilterValues(variableName="Product", values="Cadbury Dairy Milk
Chocolate 100g")
# filters now contains criteria for Year, Country and Product

R6 class that renders a pivot table in HTML.

Description

The 'PivotHtmlRenderer' class creates a HTML representation of a pivot table.

Format

R6Class object.

Methods

Public methods

• PivotHtmlRenderer$new()

• PivotHtmlRenderer$clearIsRenderedFlags()

• PivotHtmlRenderer$getTableHtml()

• PivotHtmlRenderer$clone()

Method new()

Create a new 'PivotHtmlRenderer' object.

Usage

PivotHtmlRenderer$new(parentPivot)

Arguments

Returns

A new 'PivotHtmlRenderer' object.

Method clearIsRenderedFlags()

An internal method used when rendering a pivot table to HTML. Clear the IsRendered flags that exist on the 'PivotDataGroup' class.

Usage

PivotHtmlRenderer$clearIsRenderedFlags()

Returns

No return value.

Method getTableHtml()

Generate a HTML representation of the pivot table, optionally including additional detail for debugging purposes.

Usage

PivotHtmlRenderer$getTableHtml(
  styleNamePrefix = NULL,
  includeHeaderValues = FALSE,
  includeRCFilters = FALSE,
  includeCalculationFilters = FALSE,
  includeWorkingData = FALSE,
  includeEvaluationFilters = FALSE,
  includeCalculationNames = FALSE,
  includeRawValue = FALSE,
  includeTotalInfo = FALSE,
  exportOptions = NULL,
  showRowGroupHeaders = FALSE
)

Arguments

Returns

A list containing HTML tags from the 'htmltools' package. Convert this to a character variable using 'as.character()'.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotHtmlRenderer$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by the pivot table.
# It is not intended to be created outside of the pivot table.

R6 class that renders a pivot table in Latex.

Description

The 'PivotLatexRenderer' class creates a Latex representation of a pivot table.

Format

R6Class object.

Methods

Public methods

• PivotLatexRenderer$new()

• PivotLatexRenderer$clearIsRenderedFlags()

• PivotLatexRenderer$resetVisibleRange()

• PivotLatexRenderer$setVisibleRange()

• PivotLatexRenderer$getTableLatex()

• PivotLatexRenderer$clone()

Method new()

Create a new 'PivotLatexRenderer' object.

Usage

PivotLatexRenderer$new(parentPivot = NULL)

Arguments

Returns

A new 'PivotLatexRenderer' object.

Method clearIsRenderedFlags()

An internal method used when rendering a pivot table to Latex Clear the IsRendered flags that exist on the 'PivotDataGroup' class.

Usage

PivotLatexRenderer$clearIsRenderedFlags()

Returns

No return value.

Method resetVisibleRange()

Clears the visible range that has been set, so the next call to 'getTableLatex()' will render the whole table.

Usage

PivotLatexRenderer$resetVisibleRange()

Returns

No return value.

Method setVisibleRange()

Specifies a subset of the pivot table to be rendered, e.g. for use when a pivot table will not fit into a single A4 page.

Usage

PivotLatexRenderer$setVisibleRange(
  fromRow = NULL,
  toRow = NULL,
  fromColumn = NULL,
  toColumn = NULL
)

Arguments

Returns

No return value.

Method getTableLatex()

Generate a Latex representation of the pivot table.

Usage

PivotLatexRenderer$getTableLatex(
  caption = NULL,
  label = NULL,
  boldHeadings = FALSE,
  italicHeadings = FALSE,
  exportOptions = NULL
)

Arguments

Returns

A character variable containing the Latex representation of the pivot table.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotLatexRenderer$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by the pivot table.
# It is not intended to be created outside of the pivot table.

R6 class that renders a pivot table into an Excel worksheet.

Description

The 'PivotOpenXlsxRenderer' class creates a representation of a pivot table in an Excel file using the 'openxlsx' package. See the "Excel Export" vignette for details and examples.

Format

R6Class object.

Methods

Public methods

• PivotOpenXlsxRenderer$new()

• PivotOpenXlsxRenderer$clearIsRenderedFlags()

• PivotOpenXlsxRenderer$writeToCell()

• PivotOpenXlsxRenderer$writeToWorksheet()

• PivotOpenXlsxRenderer$clone()

Method new()

Create a new 'PivotOpenXlsxRenderer' object.

Usage

PivotOpenXlsxRenderer$new(parentPivot)

Arguments

Returns

A new 'PivotOpenXlsxRenderer' object. An internal method used when rendering a pivot table to HTML. Clear the IsRendered flags that exist on the 'PivotDataGroup' class.

Method clearIsRenderedFlags()

Usage

PivotOpenXlsxRenderer$clearIsRenderedFlags()

Returns

No return value.

Method writeToCell()

Writes a value to a cell and applies styling as needed.

Usage

PivotOpenXlsxRenderer$writeToCell(
  wb = NULL,
  wsName = NULL,
  rowNumber = NULL,
  columnNumber = NULL,
  value = NULL,
  applyStyles = TRUE,
  baseStyleName = NULL,
  style = NULL,
  mapFromCss = TRUE,
  mergeRows = NULL,
  mergeColumns = NULL
)

Arguments

Returns

No return value.

Method writeToWorksheet()

Write the pivot table into the specified workbook and worksheet at the specified row-column location.

Usage

PivotOpenXlsxRenderer$writeToWorksheet(
  wb = NULL,
  wsName = NULL,
  topRowNumber = NULL,
  leftMostColumnNumber = NULL,
  outputHeadingsAs = "formattedValueAsText",
  outputValuesAs = "rawValue",
  applyStyles = TRUE,
  mapStylesFromCSS = TRUE,
  exportOptions = NULL,
  showRowGroupHeaders = FALSE
)

Arguments

Returns

No return value.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotOpenXlsxRenderer$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by the pivot table.
# It is not intended to be created outside of the pivot table.

R6 class that specifies Excel styling as used by the openxlsx package.

Description

The 'PivotOpenXlsxStyle' class specifies the styling for cells in an Excel worksheet.

Format

R6Class object.

Active bindings

Methods

Public methods

• PivotOpenXlsxStyle$new()

• PivotOpenXlsxStyle$isBasicStyleNameMatch()

• PivotOpenXlsxStyle$isFullStyleDetailMatch()

• PivotOpenXlsxStyle$createOpenXslxStyle()

• PivotOpenXlsxStyle$asList()

• PivotOpenXlsxStyle$asJSON()

• PivotOpenXlsxStyle$asString()

• PivotOpenXlsxStyle$clone()

Method new()

Create a new 'PivotOpenXlsxStyle' object.

Usage

PivotOpenXlsxStyle$new(
  parentPivot,
  baseStyleName = NULL,
  isBaseStyle = NULL,
  fontName = NULL,
  fontSize = NULL,
  bold = NULL,
  italic = NULL,
  underline = NULL,
  strikethrough = NULL,
  superscript = NULL,
  subscript = NULL,
  fillColor = NULL,
  textColor = NULL,
  hAlign = NULL,
  vAlign = NULL,
  wrapText = NULL,
  textRotation = NULL,
  indent = NULL,
  borderAll = NULL,
  borderLeft = NULL,
  borderRight = NULL,
  borderTop = NULL,
  borderBottom = NULL,
  valueFormat = NULL,
  minColumnWidth = NULL,
  minRowHeight = NULL
)

Arguments

Returns

A new 'PivotOpenXlsxStyle' object.

Method isBasicStyleNameMatch()

Test whether a style is a base style with the specified name.

Usage

PivotOpenXlsxStyle$isBasicStyleNameMatch(baseStyleName = NULL)

Arguments

Returns

No return value.

Method isFullStyleDetailMatch()

Test whether a style has matching style attributes.

Usage

PivotOpenXlsxStyle$isFullStyleDetailMatch(
  baseStyleName = NULL,
  isBaseStyle = NULL,
  fontName = NULL,
  fontSize = NULL,
  bold = NULL,
  italic = NULL,
  underline = NULL,
  strikethrough = NULL,
  superscript = NULL,
  subscript = NULL,
  fillColor = NULL,
  textColor = NULL,
  hAlign = NULL,
  vAlign = NULL,
  wrapText = NULL,
  textRotation = NULL,
  indent = NULL,
  borderAll = NULL,
  borderLeft = NULL,
  borderRight = NULL,
  borderTop = NULL,
  borderBottom = NULL,
  valueFormat = NULL,
  minColumnWidth = NULL,
  minRowHeight = NULL
)

Arguments

Details

Base styles are compared on name only, otherwise the style attributes are compared.

Returns

No return value.

Method createOpenXslxStyle()

Create an 'openxlsx' style from this style definition.

Usage

PivotOpenXlsxStyle$createOpenXslxStyle()

Returns

No return value. Retrieve the style using the 'openxlsxStyle' property.

Method asList()

Return the contents of this object as a list for debugging.

Usage

PivotOpenXlsxStyle$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

PivotOpenXlsxStyle$asJSON()

Returns

A JSON representation of various object properties.

Method asString()

Return a representation of this object as a character value.

Usage

PivotOpenXlsxStyle$asString()

Returns

A character summary of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotOpenXlsxStyle$clone(deep = FALSE)

Arguments

Examples

# PivotOpenXlsxStyle objects are created by the PivotOpenXlsxRenderer class.
# See that class for details.

R6 class that defines a collection of Excel styles as used by the openxlsx package.

Description

The 'PivotOpenXlsxStyles' class stores a collection of 'PivotOpenXlsxStyle' style objects.

Format

R6Class object.

Active bindings

Methods

Public methods

• PivotOpenXlsxStyles$new()

• PivotOpenXlsxStyles$clearStyles()

• PivotOpenXlsxStyles$findNamedStyle()

• PivotOpenXlsxStyles$findOrAddStyle()

• PivotOpenXlsxStyles$addNamedStyles()

• PivotOpenXlsxStyles$asList()

• PivotOpenXlsxStyles$asJSON()

• PivotOpenXlsxStyles$asString()

• PivotOpenXlsxStyles$clone()

Method new()

Create a new 'PivotOpenXlsxStyles' object.

Usage

PivotOpenXlsxStyles$new(parentPivot)

Arguments

Returns

A new 'PivotOpenXlsxStyles' object.

Method clearStyles()

Clear the internal list of styles.

Usage

PivotOpenXlsxStyles$clearStyles()

Returns

No return value.

Method findNamedStyle()

Find an existing openxlsx style matching the name of a base style.

Usage

PivotOpenXlsxStyles$findNamedStyle(baseStyleName)

Arguments

Returns

A 'PivotOpenXlsxStyle' object with the specified name.

Method findOrAddStyle()

Find an existing openxlsx style, add a new openxlsx style matching a base style and/or existing 'PivotStyle' object.

Usage

PivotOpenXlsxStyles$findOrAddStyle(
  action = "findOrAdd",
  baseStyleName = NULL,
  isBaseStyle = NULL,
  style = NULL,
  mapFromCss = TRUE
)

Arguments

Details

This function is used in two different ways: (1) When adding base styles (i.e. named styles in the pivot table) to this 'PivotOpenXlsxStyles' collection: In this case, 'baseStyleName' is the name of the style and 'isBaseStyle=TRUE' (so matching is by name only) and 'style' is the 'PivotStyle' object for the base style. (2) When finding styles that have been applied to individual cells using the 'PivotStyle' object that is attached to each cell: In this case, 'baseStyleName' may or may not be present, 'isBaseStyle=FALSE' and 'style' is the 'PivotStyle' object from the cell.

Returns

A 'PivotOpenXlsxStyle' object that has been found or added.

Method addNamedStyles()

Populate the OpenXlsx styles based on the styles defined in the pivot table.

Usage

PivotOpenXlsxStyles$addNamedStyles(mapFromCss = TRUE)

Arguments

Returns

No return value.

Method asList()

Return the contents of this object as a list for debugging.

Usage

PivotOpenXlsxStyles$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

PivotOpenXlsxStyles$asJSON()

Returns

A JSON representation of various object properties.

Method asString()

Return a representation of this object as a character value.

Usage

PivotOpenXlsxStyles$asString(seperator = ", ")

Arguments

Returns

A character summary of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotOpenXlsxStyles$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by the pivot table.
# It is not intended to be created outside of the pivot table.

R6 class that specifies styling.

Description

The 'PivotStyle' class specifies the styling for headers and cells in a pivot table. Styles are specified in the form of Cascading Style Sheet (CSS) name-value pairs.

Format

R6Class object.

Active bindings

Methods

Public methods

• PivotStyle$new()

• PivotStyle$setPropertyValue()

• PivotStyle$setPropertyValues()

• PivotStyle$getPropertyValue()

• PivotStyle$asCSSRule()

• PivotStyle$asNamedCSSStyle()

• PivotStyle$getCopy()

• PivotStyle$asList()

• PivotStyle$asJSON()

• PivotStyle$clone()

Method new()

Create a new 'PivotStyle' object.

Usage

PivotStyle$new(parentPivot, styleName = NULL, declarations = NULL)

Arguments

Returns

A new 'PivotStyle' object.

Method setPropertyValue()

Set a single style property.

Usage

PivotStyle$setPropertyValue(property = NULL, value = NULL)

Arguments

Returns

No return value.

Method setPropertyValues()

Set multiple style properties.

Usage

PivotStyle$setPropertyValues(declarations = NULL)

Arguments

Returns

No return value.

Method getPropertyValue()

Get the value of a single style property.

Usage

PivotStyle$getPropertyValue(property = NULL)

Arguments

Returns

The value of the style property.

Method asCSSRule()

Get the style definition in the form of a CSS rule.

Usage

PivotStyle$asCSSRule(selector = NULL)

Arguments

Returns

The style declarations in the form of a CSS rule, i.e. selector { property-name1: property-value1, property-name2: property-value2, ... } e.g. div { font-weight: bold, color: #0000FF }

Method asNamedCSSStyle()

Get the style definition in the form of a named CSS style.

Usage

PivotStyle$asNamedCSSStyle(styleNamePrefix = NULL)

Arguments

Returns

The style declarations in the form of named CSS style, i.e. .prefix-stylename { property-name1: property-value1, property-name2: property-value2, ... } e.g. .pvt1Cell { font-weight: bold, color: #0000FF }

Method getCopy()

Create a copy of this 'PivotStyle' object.

Usage

PivotStyle$getCopy(newStyleName = NULL)

Arguments

Returns

A 'PivotStyle' object.

Method asList()

Return the contents of this object as a list for debugging.

Usage

PivotStyle$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

PivotStyle$asJSON()

Returns

A JSON representation of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotStyle$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by the pivot table.
# It is not intended to be created outside of the pivot table.

R6 class that defines a collection of styles.

Description

The 'PivotStyles' class is a collection of 'PivotStyle' objects. It defines all of the base styles needed to style/theme a pivot table. It also defines the names of the styles that are used for styling the different parts of the pivot table.

Format

R6Class object.

Active bindings

Methods

Public methods

• PivotStyles$new()

• PivotStyles$isExistingStyle()

• PivotStyles$getStyle()

• PivotStyles$addStyle()

• PivotStyles$copyStyle()

• PivotStyles$asCSSRule()

• PivotStyles$asNamedCSSStyle()

• PivotStyles$asList()

• PivotStyles$asJSON()

• PivotStyles$asString()

• PivotStyles$clone()

Method new()

Create a new 'PivotStyles' object.

Usage

PivotStyles$new(parentPivot, themeName = NULL, allowExternalStyles = FALSE)

Arguments

Returns

A new 'PivotStyles' object.

Method isExistingStyle()

Check whether a style with the specified style name exists in the collection.

Usage

PivotStyles$isExistingStyle(styleName = NULL)

Arguments

Returns

'TRUE' if a style with the specified name exists, 'FALSE' otherwise.

Method getStyle()

Retrieve a style with the specified style name.

Usage

PivotStyles$getStyle(styleName = NULL)

Arguments

Returns

A 'PivotStyle' object.

Method addStyle()

Add a new style to the collection of styles.

Usage

PivotStyles$addStyle(styleName = NULL, declarations = NULL)

Arguments

Returns

The newly created 'PivotStyle' object.

Method copyStyle()

Create a copy of a style with the specified name and store it in the collection.

Usage

PivotStyles$copyStyle(styleName = NULL, newStyleName = NULL)

Arguments

Returns

The newly created 'PivotStyle' object.

Method asCSSRule()

Get a style definition in the form of a CSS rule.

Usage

PivotStyles$asCSSRule(styleName = NULL, selector = NULL)

Arguments

Returns

The style declarations in the form of a CSS rule, i.e. selector { property-name1: property-value1, property-name2: property-value2, ... } e.g. div { font-weight: bold, color: #0000FF }

Method asNamedCSSStyle()

Get a style definition in the form of a named CSS style.

Usage

PivotStyles$asNamedCSSStyle(styleName = NULL, styleNamePrefix = NULL)

Arguments

Returns

The style declarations in the form of named CSS style, i.e. .prefix-stylename { property-name1: property-value1, property-name2: property-value2, ... } e.g. .pvt1Cell { font-weight: bold, color: #0000FF }

Method asList()

Return the contents of this object as a list for debugging.

Usage

PivotStyles$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

PivotStyles$asJSON()

Returns

A JSON representation of various object properties.

Method asString()

Return a representation of this object as a character value.

Usage

PivotStyles$asString(seperator = ", ")

Arguments

Returns

A character summary of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

PivotStyles$clone(deep = FALSE)

Arguments

Examples

pt <- PivotTable$new()
# ...
pivotStyles <- PivotStyles$new(pt, themeName="compact")
pivotStyles$addStyle(styleName="MyNewStyle", list(
    font="0.75em arial",
    padding="2px",
    border="1px solid lightgray",
    "vertical-align"="middle",
    "text-align"="center",
    "font-weight"="bold",
    "background-color"="#F2F2F2"
  ))

R6 class that represents a pivot table.

Description

The 'PivotTable' class is the primary class for constructing and interacting with a pivot table.

Format

R6Class object.

Active bindings

Methods

Public methods

• PivotTable$new()

• PivotTable$setDefault()

• PivotTable$getDefault1()

• PivotTable$getDefault2()

• PivotTable$getDefault3()

• PivotTable$getNextInstanceId()

• PivotTable$addData()

• PivotTable$addTotalData()

• PivotTable$getColumnGroupsByLevel()

• PivotTable$getTopColumnGroups()

• PivotTable$getLeafColumnGroups()

• PivotTable$getLeafColumnGroup()

• PivotTable$addColumnGroup()

• PivotTable$addColumnDataGroups()

• PivotTable$normaliseColumnGroups()

• PivotTable$sortColumnDataGroups()

• PivotTable$getRowGroupsByLevel()

• PivotTable$getTopRowGroups()

• PivotTable$getLeafRowGroups()

• PivotTable$getLeafRowGroup()

• PivotTable$addRowGroup()

• PivotTable$addRowDataGroups()

• PivotTable$normaliseRowGroups()

• PivotTable$sortRowDataGroups()

• PivotTable$setRowDataGroupHeader()

• PivotTable$addCalculationGroup()

• PivotTable$defineCalculation()

• PivotTable$addColumnCalculationGroups()

• PivotTable$addRowCalculationGroups()

• PivotTable$addStyle()

• PivotTable$createInlineStyle()

• PivotTable$setStyling()

• PivotTable$mapStyling()

• PivotTable$generateCellStructure()

• PivotTable$resetCells()

• PivotTable$evaluateCells()

• PivotTable$evaluatePivot()

• PivotTable$findRowDataGroups()

• PivotTable$findColumnDataGroups()

• PivotTable$getEmptyRows()

• PivotTable$getEmptyColumns()

• PivotTable$getCell()

• PivotTable$getCells()

• PivotTable$findCells()

• PivotTable$findGroupColumnNumbers()

• PivotTable$findGroupRowNumbers()

• PivotTable$removeColumn()

• PivotTable$removeColumns()

• PivotTable$removeEmptyColumns()

• PivotTable$removeRow()

• PivotTable$removeRows()

• PivotTable$removeEmptyRows()

• PivotTable$print()

• PivotTable$asMatrix()

• PivotTable$asDataMatrix()

• PivotTable$asDataFrame()

• PivotTable$asTidyDataFrame()

• PivotTable$getMerges()

• PivotTable$asBasicTable()

• PivotTable$getCss()

• PivotTable$getHtml()

• PivotTable$saveHtml()

• PivotTable$renderPivot()

• PivotTable$getLatex()

• PivotTable$writeToExcelWorksheet()

• PivotTable$trace()

• PivotTable$showBatchInfo()

• PivotTable$asList()

• PivotTable$asJSON()

• PivotTable$viewJSON()

• PivotTable$clone()

Method new()

Create a new 'PivotTable' object.

Usage

PivotTable$new(
  processingLibrary = "auto",
  evaluationMode = "batch",
  argumentCheckMode = "auto",
  theme = NULL,
  replaceExistingStyles = FALSE,
  tableStyle = NULL,
  headingStyle = NULL,
  cellStyle = NULL,
  totalStyle = NULL,
  compatibility = NULL,
  traceEnabled = FALSE,
  traceFile = NULL
)

Arguments

Returns

A new 'PivotTable' object.

Method setDefault()

Specify default values for some function arguments.

Usage

PivotTable$setDefault(...)

Arguments

Details

Defaults can be set for the following arguments of 'pt$addRowDataGroups()' and 'pt$addColumnDataGroups()': 'logical' values: 'addTotal', 'expandExistingTotals', 'visualTotals'. 'character' values: 'totalPosition', 'totalCaption'. 'list' or 'logical' values: 'outlineBefore', 'outlineAfter', 'outlineTotal'.
Errors are generated for default values that could not be set.
Warnings are generated for attempts to set defaults that aren't supported.
See the "A1. Appendix" vignette for more details.

Returns

No return value.

Method getDefault1()

Get the default value of an argument.

Usage

PivotTable$getDefault1(argValue = NULL, useDefault = NULL)

Arguments

Details

Both the argument name and argument value are taken from the 'argValue' argument. The name is obtained from 'as.character(substitute(argValue))'. This function is designed to easily slot into existing code, e.g. 'getDefault1(addTotal, missing(addTotal))'.

Returns

The current value of the argument or the default value.

Method getDefault2()

Get the default value of an argument.

Usage

PivotTable$getDefault2(argName = NULL, argValue = NULL, useDefault = NULL)

Arguments

Returns

The current value of the argument or the default value.

Method getDefault3()

Get the default value of an argument.

Usage

PivotTable$getDefault3(argName)

Arguments

Returns

The default value.

Method getNextInstanceId()

Get the next unique object instance identifier.

Usage

PivotTable$getNextInstanceId()

Details

R6 classes cannot be easily compared to check if two variables are both referring to the same object instance. Instance ids are a mechanism to work around this problem. Each data group and cell is assigned an instance id during object creation, which enables reliable reference comparisons.

Returns

An integer instance id.

Method addData()

Add a data frame with the specified name to the pivot table.

Usage

PivotTable$addData(dataFrame = NULL, dataName = NULL)

Arguments

Details

The name is used to refer to the data frame when generating data groups or defining calculations. The pivot table tracks the first data frame added as the default data frame, so if only a single data frame is used, it is typically not necessary to ever explicitly refer to the name. Pivot tables are typically based on a single data frame, however it is possible to build a pivot table that uses data from multiple data frames.

Returns

The 'PivotData' object managing the data frames for the pivot table.

Method addTotalData()

Add a data frame containing totals data with the specified name and variables to the pivot table.

Usage

PivotTable$addTotalData(
  dataFrame = NULL,
  dataName = NULL,
  variableNames = NULL
)

Arguments

Details

When generating pivot tables, the package typically calculates cell values. However, the package can also use provided values (i.e. carry out no calculations). This presents a challenge in that the sub-totals and totals in a pivot table display values at a higher aggregation level than the normal cells in the body of the pivot table. This method allows further data frames to be specified that contain aggregated versions of the data. See the "Calculations" vignette for details and an example.

Returns

No return value.

Method getColumnGroupsByLevel()

Retrieve the data groups at the specified level or levels in the column groups hierarchy.

Usage

PivotTable$getColumnGroupsByLevel(level = NULL, collapse = FALSE)

Arguments

Details

If 'level' is a vector: If 'collapse' is 'FALSE', then a list of lists is returned, if 'collapse' is 'TRUE', then a single combined list is returned.

Returns

A list containing 'PivotDataGroup' objects.

Method getTopColumnGroups()

[Deprecated: Use topColumnGroups instead] Retrieve the first level of column data groups.

Usage

PivotTable$getTopColumnGroups()

Returns

A list containing 'PivotDataGroup' objects.

Method getLeafColumnGroups()

[Deprecated: Use leafColumnGroups instead] Retrieve the bottom level of column data groups.

Usage

PivotTable$getLeafColumnGroups()

Returns

A list containing 'PivotDataGroup' objects.

Method getLeafColumnGroup()

Retrieve the leaf-level data group associated with a specific column or columns.

Usage

PivotTable$getLeafColumnGroup(c = NULL)

Arguments

Returns

A 'PivotDataGroup' object or a list of 'PivotDataGroup' objects.

Method addColumnGroup()

Add a new column data group at the top level of the column group hierarchy. The new group is added as the last child unless an index is specified.

Usage

PivotTable$addColumnGroup(
  variableName = NULL,
  filterType = "ALL",
  values = NULL,
  doNotExpand = FALSE,
  isEmpty = FALSE,
  isOutline = FALSE,
  styleAsOutline = FALSE,
  captionTemplate = "{value}",
  caption = NULL,
  isTotal = FALSE,
  isLevelSubTotal = FALSE,
  isLevelTotal = FALSE,
  calculationGroupName = NULL,
  calculationName = NULL,
  baseStyleName = NULL,
  styleDeclarations = NULL,
  insertAtIndex = NULL,
  insertBeforeGroup = NULL,
  insertAfterGroup = NULL,
  mergeEmptySpace = NULL,
  cellBaseStyleName = NULL,
  cellStyleDeclarations = NULL,
  sortAnchor = NULL,
  resetCells = TRUE
)

Arguments

Details

See the "Irregular Layout" vignette for details and examples.

Returns

The new 'PivotDataGroup' object.

Method addColumnDataGroups()

Add multiple new data groups to the column group hierarchy based on the distinct values in a data frame column or using explicitly specified data values. See the "Data Groups" vignette for example usage.

Usage

PivotTable$addColumnDataGroups(
  variableName = NULL,
  atLevel = NULL,
  fromData = TRUE,
  dataName = NULL,
  dataSortOrder = "asc",
  customSortOrder = NULL,
  caption = "{value}",
  dataFormat = NULL,
  dataFmtFuncArgs = NULL,
  onlyCombinationsThatExist = TRUE,
  explicitListOfValues = NULL,
  calculationGroupName = NULL,
  expandExistingTotals = FALSE,
  addTotal = TRUE,
  visualTotals = FALSE,
  totalPosition = "after",
  totalCaption = "Total",
  onlyAddGroupIf = NULL,
  preGroupData = TRUE,
  baseStyleName = NULL,
  styleDeclarations = NULL
)

Arguments