pivottabler (version 1.3.0)

PivotBatchCalculator: A class that calculates the values for multiple cells.

Description

The PivotBatchCalculator class calculates the values for multiple cells in the pivot table in one evaluation step.

Value

Object of R6Class with properties and methods that help to perform calculations in batch.

Format

R6Class object.

Fields

parentPivot

Owning pivot table.

batchCount

The number of batches generated for the pivot table.

calculationSummary

A summary of the batch compatibility for each calculation.

batchSummary

A summary of the batches in the pivot table.

Methods

Documentation

For more complete explanations and examples please see the extensive vignettes supplied with this package.

new(...)

Create a new batch calculator.

reset()

Clears any batches that currently exist in the batch calculator.

isFiltersBatchCompatible(filters=NULL)

Determines whether a set of filters are compatible with batch calculations.

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

Generates one or more batches for a named calculation and single working filters object.

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

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

generateBatchesForCellEvaluation()

Generates one or batches for a pivot table cell.

evaluateBatches()

Evaluates batch calculations.

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

Retrieve a value from a the results of a batch that has been evaluated.

Examples

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