R6 class that defines a basic table.

Description

The 'BasicTable' class represents a table with styling and formatting that can be rendered to multiple output formats.

Format

R6Class object.

Active bindings

Methods

Public methods

• BasicTable$new()

• BasicTable$getNextInstanceId()

• BasicTable$addData()

• BasicTable$addMatrix()

• BasicTable$mergeCells()

• BasicTable$unmergeCells()

• BasicTable$applyCellMerges()

• BasicTable$formatValue()

• BasicTable$addStyle()

• BasicTable$createInlineStyle()

• BasicTable$setStyling()

• BasicTable$mapStyling()

• BasicTable$resetCells()

• BasicTable$getCells()

• BasicTable$findCells()

• BasicTable$print()

• BasicTable$asMatrix()

• BasicTable$asDataFrame()

• BasicTable$getCss()

• BasicTable$getHtml()

• BasicTable$saveHtml()

• BasicTable$renderTable()

• BasicTable$writeToExcelWorksheet()

• BasicTable$asFlexTable()

• BasicTable$trace()

• BasicTable$asList()

• BasicTable$asJSON()

• BasicTable$viewJSON()

• BasicTable$clone()

Method new()

Create a new 'BasicTable' object.

Usage

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

Arguments

Returns

No return value.

Method getNextInstanceId()

Get the next unique object instance identifier.

Usage

BasicTable$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 cell is assigned an instance id during object creation, which enables reliable reference comparisons.

Returns

An integer instance id.

Method addData()

Populate the table from a data frame, specifying headers and value formatting.

Usage

BasicTable$addData(
  dataFrame = NULL,
  columnNamesAsColumnHeaders = TRUE,
  explicitColumnHeaders = NULL,
  rowNamesAsRowHeaders = FALSE,
  firstColumnAsRowHeaders = FALSE,
  explicitRowHeaders = NULL,
  numberOfColumnsAsRowHeaders = 0,
  columnFormats = NULL,
  fmtFuncArgs = NULL,
  columnCellTypes = NULL,
  baseStyleNames = NULL
)

Arguments

Returns

No return value.

Method addMatrix()

Populate the table from a matrix, specifying headers and value formatting.

Usage

BasicTable$addMatrix(
  matrix = NULL,
  columnNamesAsColumnHeaders = TRUE,
  explicitColumnHeaders = NULL,
  rowNamesAsRowHeaders = FALSE,
  explicitRowHeaders = NULL,
  columnFormats = NULL,
  baseStyleNames = NULL,
  fmtFuncArgs = NULL
)

Arguments

Returns

No return value.

Method mergeCells()

Merge table cells by specifying either:
The top left cell (rFrom, cFrom) and the merged cell size (rSpan, cSpan) or, The top left cell (rFrom, cFrom) and bottom-right cell (rTo, cTo), or The ranges of rows/columns as vectors using rowNumbers and columnNumbers.

Usage

BasicTable$mergeCells(
  rFrom = NULL,
  cFrom = NULL,
  rSpan = NULL,
  cSpan = NULL,
  rTo = NULL,
  cTo = NULL,
  rowNumbers = NULL,
  columnNumbers = NULL
)

Arguments

Returns

No return value.

Method unmergeCells()

Unmerge a set of merged cells by specifying any cell within the set of merged cells.

Usage

BasicTable$unmergeCells(r = NULL, c = NULL, errorIfNotFound = TRUE)

Arguments

Returns

A new 'TableCell' object.

Method applyCellMerges()

Internal method that sets the 'isMerged' and 'mergeIndex' properties on each cell based on the cell merges that have been specified.

Usage

BasicTable$applyCellMerges()

Returns

No return value.

Method formatValue()

Format a value using a variety of different methods.

Usage

BasicTable$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 addStyle()

Add a new named style to the table.

Usage

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

Arguments

Returns

The newly created 'TableStyle' object.

Method createInlineStyle()

Create an inline style that can be used to override a base style. For general use cases, the 'setStyling()' method provides a simpler and more direct way of styling specific parts of a table.

Usage

BasicTable$createInlineStyle(baseStyleName = NULL, declarations = NULL)

Arguments

Details

Inline styles are typically used to override the style of some specific cells in a table. Inline styles have no name. In HTML, they are rendered as 'style' attributes on specific table cells, where as named styles are linked to cells using the 'class' attribute.

Returns

The newly created 'TableStyle' object.

Method setStyling()

Apply styling to a set of cells in the table.

Usage

BasicTable$setStyling(
  rFrom = NULL,
  cFrom = NULL,
  rTo = NULL,
  cTo = NULL,
  rowNumbers = NULL,
  columnNumbers = NULL,
  cells = NULL,
  cellType = NULL,
  visible = NULL,
  baseStyleName = NULL,
  style = NULL,
  declarations = NULL,
  applyBorderToAdjacentCells = FALSE
)

Arguments

Details

There are five ways to specify the part(s) of a table to apply styling to:
(1) By specifying a list of data groups using the 'groups' argument.
(2) By specifying a list of cells using the 'cells' argument.
(3) By specifying a single cell using the 'rFrom' and 'cFrom' arguments.
(4) By specifying a rectangular cell range using the 'rFrom', 'cFrom', 'rTo' and 'cTo' arguments.
(5) By specifying a vector of rowNumbers and/or columnNumbers. If both rowNumbers and columnNumbers are specified, then the cells at the intersection of the specified row numbers and column numbers are styled.
If both rFrom/rTo and rowNumbers are specified, then rFrom/rTo constrain the row numbers specified in rowNumbers.
If both cFrom/cTo and columnNumbers are specified, then cFrom/cTo constrain the column numbers specified in columnNumbers.
See the "Styling" and "Finding and Formatting" vignettes for more information and many examples.

Returns

No return value.

Method mapStyling()

Apply styling to table cells based on the value of each cell.

Usage

BasicTable$mapStyling(
  styleProperty = NULL,
  cells = NULL,
  valueType = "text",
  mapType = "range",
  mappings = NULL,
  styleLowerValues = FALSE,
  styleHigherValues = TRUE
)

Arguments

Details

'mapStyling()' is typically used to conditionally apply styling to cells based on the value of each individual cell, e.g. cells with values less than a specified number could be coloured red.
mapType="logic" maps values matching specified logical criteria to specific "to" values. The logical criteria can be any of the following forms (the first matching mapping is used):
(1) a specific value, e.g. 12.
(2) a specific value equality condition, e.g. "v==12", where v represents the cell value.
(3) a value range expression using the following abbreviated form: "value1<=v<value2", e.g. "10<=v<15". Only "<" or "<=" can be used in these value range expressions.
(4) a standard R logical expression, e.g. "10<=v && v<15".
Basic R functions that test the value can also be used, e.g. is.na(v).
See the "Styling" and Finding and Formatting" vignettes for more information and many examples.

Returns

No return value.

Method resetCells()

Clear the cells of the table.

Usage

BasicTable$resetCells()

Details

The cells are reset automatically when structural changes are made to the table, so this method often doesn't needs to be called explicitly.

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

BasicTable$getCells(
  specifyCellsAsList = TRUE,
  rowNumbers = NULL,
  columnNumbers = NULL,
  cellCoordinates = NULL,
  excludeEmptyCells = FALSE,
  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 'TableCell' objects.

Method findCells()

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

Usage

BasicTable$findCells(
  minValue = NULL,
  maxValue = NULL,
  exactValues = NULL,
  valueRanges = NULL,
  includeNull = TRUE,
  includeNA = TRUE,
  emptyCells = "include",
  rowNumbers = NULL,
  columnNumbers = NULL,
  cellCoordinates = NULL,
  cells = NULL,
  rowColumnMatchMode = "simple"
)

Arguments

Details

The valueRanges parameter can be any of the following forms:
(1) a specific value, e.g. 12.
(2) a specific value equality condition, e.g. "v==12", where v represents the cell value.
(3) a value range expression using the following abbreviated form: "value1<=v<value2", e.g. "10<=v<15". Only "<" or "<=" can be used in these value range expressions.
(4) a standard R logical expression, e.g. "10<=v && v<15".
Basic R functions that test the value can also be used, e.g. is.na(v).

Returns

A list of 'TableCell' objects.

Method print()

Outputs a plain text representation of the table to the console or returns a character representation of the table.

Usage

BasicTable$print(asCharacter = FALSE)

Arguments

Returns

Plain text representation of the table.

Method asMatrix()

Convert the table to a matrix, with or without headings.

Usage

BasicTable$asMatrix(
  firstRowAsColumnNames = FALSE,
  firstColumnAsRowNames = FALSE,
  rawValue = FALSE
)

Arguments

Details

See the "Outputs" vignette for a comparison of outputs.

Returns

A matrix.

Method asDataFrame()

Convert the table to a data frame, with or without headings.

Usage

BasicTable$asDataFrame(
  firstRowAsColumnNames = FALSE,
  firstColumnAsRowNames = FALSE,
  rawValue = FALSE,
  stringsAsFactors = NULL
)

Arguments

Details

See the "Outputs" vignette for a comparison of outputs.

Returns

A matrix.

Method getCss()

Get the CSS declarations for the table.

Usage

BasicTable$getCss(styleNamePrefix = NULL)

Arguments

Details

See the "Outputs" vignette for more details and examples.

Returns

A character value containing the CSS style declaration.

Method getHtml()

Generate a HTML representation of the table.

Usage

BasicTable$getHtml(styleNamePrefix = NULL)

Arguments

Details

See the "Outputs" vignette for more details and examples.

Returns

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

Method saveHtml()

Save a HTML representation of the table to file.

Usage

BasicTable$saveHtml(
  filePath = NULL,
  fullPageHTML = TRUE,
  styleNamePrefix = NULL
)

Arguments

Details

See the "Outputs" vignette for more details and examples.

Returns

No return value.

Method renderTable()

Render a HTML representation of the table as an HTML widget.

Usage

BasicTable$renderTable(width = NULL, height = NULL, styleNamePrefix = NULL)

Arguments

Details

See the "Outputs" vignette for more details and examples.

Returns

A HTML widget from the 'htmlwidgets' package.

Method writeToExcelWorksheet()

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

Usage

BasicTable$writeToExcelWorksheet(
  wb = NULL,
  wsName = NULL,
  topRowNumber = NULL,
  leftMostColumnNumber = NULL,
  outputValuesAs = "rawValue",
  useFormattedValueIfRawValueIsNull = TRUE,
  applyStyles = TRUE,
  mapStylesFromCSS = TRUE
)

Arguments

Details

See the Excel Output vignette for more details.

Returns

No return value.

Method asFlexTable()

Convert table to a flextable table..

Usage

BasicTable$asFlexTable(applyStyles = TRUE, mapStylesFromCSS = TRUE)

Arguments

Details

See the Outputs vignette for more details.

Returns

A table from the flextable package.

Method trace()

Capture a call for tracing purposes. This is an internal method.

Usage

BasicTable$trace(methodName, desc, detailList = NULL)

Arguments

Returns

No return value.

Method asList()

Return the contents of the table as a list for debugging.

Usage

BasicTable$asList()

Returns

A list of various object properties..

Method asJSON()

Return the contents of the table as JSON for debugging.

Usage

BasicTable$asJSON()

Returns

A JSON representation of various object properties.

Method viewJSON()

Use the 'listviewer' package to view the table as JSON for debugging.

Usage

BasicTable$viewJSON()

Returns

No return value.

Method clone()

The objects of this class are cloneable with this method.

Usage

BasicTable$clone(deep = FALSE)

Arguments

Examples

# The package vignettes have many more examples of working with the
# BasicTable class.
# Quickly rendering a table as an htmlwidget:
library(basictabler)
qhtbl(data.frame(a=1:2, b=3:4))
# Rendering a larger table as an htmlwidget:
library(basictabler)
library(dplyr)
tocsummary <- bhmsummary %>%
  group_by(TOC) %>%
  summarise(OnTimeArrivals=sum(OnTimeArrivals),
            OnTimeDepartures=sum(OnTimeDepartures),
            TotalTrains=sum(TrainCount)) %>%
  ungroup() %>%
  mutate(OnTimeArrivalPercent=OnTimeArrivals/TotalTrains*100,
         OnTimeDeparturePercent=OnTimeDepartures/TotalTrains*100) %>%
  arrange(TOC)

tbl <- BasicTable$new()
columnHeaders <- c("TOC", "On-Time Arrivals", "On-Time Departures",
  "Total Trains", "On-Time Arrival %", "On-Time Departure %")
columnFormats=list()
columnFormats[[2]] <- list(big.mark=",")
columnFormats[[3]] <- list(big.mark=",")
columnFormats[[4]] <- list(big.mark=",")
columnFormats[[5]] <- "%.1f"
columnFormats[[6]] <- "%.1f"
tbl$addData(tocsummary, columnNamesAsColumnHeaders=FALSE,
  firstColumnAsRowHeaders=TRUE,
  explicitColumnHeaders=columnHeaders, columnFormats=columnFormats)
tbl$renderTable()

R6 class that converts a table to a flextable from the 'flextabler' package.

Description

The 'FlexTableRenderer' class creates a representation of a table using the 'flextable' package. See the Output vignette for more details.

Format

R6Class object.

Methods

Public methods

• FlexTableRenderer$new()

• FlexTableRenderer$writeToCell()

• FlexTableRenderer$writeBorder()

• FlexTableRenderer$asFlexTable()

• FlexTableRenderer$clone()

Method new()

Create a new 'FlexTableRenderer' object.

Usage

FlexTableRenderer$new(parentTable)

Arguments

Returns

No return value.

Method writeToCell()

Write a value to a cell, optionally with styling and cell merging.

Usage

FlexTableRenderer$writeToCell(
  ft = NULL,
  rowNumber = NULL,
  columnNumber = NULL,
  totalRowCount = NULL,
  totalColumnCount = NULL,
  value = NULL,
  applyStyles = TRUE,
  baseStyleName = NULL,
  style = NULL,
  mapFromCss = TRUE,
  mergeRows = NULL,
  mergeColumns = NULL
)

Arguments

Returns

The updated flextable definition.

Method writeBorder()

Write the borders of a cell.

Usage

FlexTableRenderer$writeBorder(
  ft = NULL,
  rowNumber = NULL,
  columnNumber = NULL,
  totalRowCount = NULL,
  totalColumnCount = NULL,
  border = NULL,
  borderLeft = NULL,
  borderRight = NULL,
  borderTop = NULL,
  borderBottom = NULL
)

Arguments

Returns

The updated flextable definition.

Method asFlexTable()

Convert table to a flextable table.

Usage

FlexTableRenderer$asFlexTable(applyStyles = TRUE, mapStylesFromCSS = TRUE)

Arguments

Returns

No return value.

Method clone()

The objects of this class are cloneable with this method.

Usage

FlexTableRenderer$clone(deep = FALSE)

Arguments

Examples

# This class should not be used by end users.  It is an internal class
# created only by the BasicTable class.  It is used when converting to a
# flextable.

R6 class that specifies styling as used by the 'flextable' package.

Description

The 'FlexTableStyle' class specifies the styling for cells in a table from the flextable package.

Format

R6Class object.

Active bindings

Methods

Public methods

• FlexTableStyle$new()

• FlexTableStyle$isBasicStyleNameMatch()

• FlexTableStyle$isFullStyleDetailMatch()

• FlexTableStyle$asList()

• FlexTableStyle$asJSON()

• FlexTableStyle$asString()

• FlexTableStyle$clone()

Method new()

Create a new 'FlexTableStyle' object.

Usage

FlexTableStyle$new(
  parentTable,
  baseStyleName = NULL,
  isBaseStyle = NULL,
  fontName = NULL,
  fontSize = NULL,
  bold = NULL,
  italic = NULL,
  bgColor = NULL,
  textColor = NULL,
  hAlign = NULL,
  vAlign = NULL,
  textRotation = NULL,
  paddingAll = NULL,
  paddingLeft = NULL,
  paddingRight = NULL,
  paddingTop = NULL,
  paddingBottom = NULL,
  borderAll = NULL,
  borderLeft = NULL,
  borderRight = NULL,
  borderTop = NULL,
  borderBottom = NULL
)

Arguments

Returns

No return value.

Method isBasicStyleNameMatch()

Check if this style matches the specified base style name.

Usage

FlexTableStyle$isBasicStyleNameMatch(baseStyleName = NULL)

Arguments

Returns

'TRUE' if the style name matches, 'FALSE' otherwise.

Method isFullStyleDetailMatch()

Check if this style matches the specified style properties.

Usage

FlexTableStyle$isFullStyleDetailMatch(
  baseStyleName = NULL,
  isBaseStyle = NULL,
  fontName = NULL,
  fontSize = NULL,
  bold = NULL,
  italic = NULL,
  bgColor = NULL,
  textColor = NULL,
  hAlign = NULL,
  vAlign = NULL,
  textRotation = NULL,
  paddingAll = NULL,
  paddingLeft = NULL,
  paddingRight = NULL,
  paddingTop = NULL,
  paddingBottom = NULL,
  borderAll = NULL,
  borderLeft = NULL,
  borderRight = NULL,
  borderTop = NULL,
  borderBottom = NULL
)

Arguments

Returns

'TRUE' if the style matches, 'FALSE' otherwise.

Method asList()

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

Usage

FlexTableStyle$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

FlexTableStyle$asJSON()

Returns

A JSON representation of various object properties.

Method asString()

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

Usage

FlexTableStyle$asString()

Returns

A character representation of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

FlexTableStyle$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by using the functions in the table.
# It is not intended to be created by users outside of the table.

R6 class that defines a collection of styles as used by the 'flextable' package.

Description

The 'FlexTableStyles' class stores a collection of 'FlexTableStyle' style objects.

Format

R6Class object.

Active bindings

Methods

Public methods

• FlexTableStyles$new()

• FlexTableStyles$clearStyles()

• FlexTableStyles$findNamedStyle()

• FlexTableStyles$findOrAddStyle()

• FlexTableStyles$addNamedStyles()

• FlexTableStyles$asList()

• FlexTableStyles$asJSON()

• FlexTableStyles$asString()

• FlexTableStyles$clone()

Method new()

Create a new 'FlexTableStyles' object.

Usage

FlexTableStyles$new(parentTable)

Arguments

Returns

No return value.

Method clearStyles()

Clear the collection removing all styles.

Usage

FlexTableStyles$clearStyles()

Returns

No return value.

Method findNamedStyle()

Find a style in the collection matching the specified base style name.

Usage

FlexTableStyles$findNamedStyle(baseStyleName)

Arguments

Returns

A 'TableTableFlexTbl' object that is the style matching the specified base style name or 'NULL' otherwise.

Method findOrAddStyle()

Find a style in the collection matching the specified base style name and style properties. If there is no matching style, then optionally add a new style.

Usage

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

Arguments

Returns

A 'TableTableFlexTbl' object that is the style matching the specified base style name or 'NULL' otherwise.

Method addNamedStyles()

Populate the FlexTbl styles based on the styles defined in the table.

Usage

FlexTableStyles$addNamedStyles(mapFromCss = TRUE)

Arguments

Returns

No return value.

Method asList()

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

Usage

FlexTableStyles$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

FlexTableStyles$asJSON()

Returns

A JSON representation of various object properties.

Method asString()

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

Usage

FlexTableStyles$asString(seperator = ", ")

Arguments

Returns

A character representation of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

FlexTableStyles$clone(deep = FALSE)

Arguments

Examples

# This class should not be used by end users.  It is an internal class
# created only by the BasicTable class.  It is used when converting to a
# flextable.

Convert a number of pixels to points

Description

PxToPt converts pixels to points. 1inch = 72pt = 96px according to W3C. Ref: https://www.w3.org/TR/css3-values/#absolute-lengths

Usage

PxToPt(px)

Arguments

Value

The corresponding number of points.

R6 class that represents a cell in a table.

Description

The 'TableCell' class represents a cell in a table. Both header cells and body cells are represented by this class.

Format

R6Class object.

Active bindings

Methods

Public methods

• TableCell$new()

• TableCell$updatePosition()

• TableCell$getCopy()

• TableCell$asList()

• TableCell$asJSON()

• TableCell$clone()

Method new()

Create a new 'TableCell' object.

Usage

TableCell$new(
  parentTable,
  rowNumber = NULL,
  columnNumber = NULL,
  cellType = "cell",
  visible = TRUE,
  rawValue = NULL,
  formattedValue = NULL,
  baseStyleName = NULL,
  styleDeclarations = NULL,
  asNBSP = FALSE
)

Arguments

Returns

No return value.

Method updatePosition()

Set the cell location in the table. Mainly exists for internal use. Typically used after rows/columns/cells are inserted or deleted (which shifts other cells).

Usage

TableCell$updatePosition(rowNumber = NULL, columnNumber = NULL)

Arguments

Returns

No return value.

Method getCopy()

Stub only (ignore).

Usage

TableCell$getCopy()

Returns

No return value.

Method asList()

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

Usage

TableCell$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

TableCell$asJSON()

Returns

A JSON representation of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

TableCell$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by using the functions in the table.
# It is not intended to be created by users outside of the table.
library(basictabler)
tbl <- qtbl(data.frame(a=1:2, b=3:4))
cell1 <- tbl$cells$setCell(r=4, c=1, cellType="cell", rawValue=5)
cell2 <- tbl$cells$setCell(r=4, c=2, cellType="cell", rawValue=6)
tbl$renderTable()

R6 class that manages cell ranges (e.g. for merged cells).

Description

The 'TableCellRanges' class contains a list of cell ranges and provides basic utility methods such as finding intersecting ranges to support the functioning of the 'BasicTable' class.

Format

R6Class object.

Active bindings

Methods

Public methods

• TableCellRanges$new()

• TableCellRanges$addRange()

• TableCellRanges$findIntersectingRange()

• TableCellRanges$deleteRange()

• TableCellRanges$clear()

• TableCellRanges$updateAfterRowInsert()

• TableCellRanges$updateAfterRowDelete()

• TableCellRanges$updateAfterColumnInsert()

• TableCellRanges$updateAfterColumnDelete()

• TableCellRanges$asList()

• TableCellRanges$asJSON()

• TableCellRanges$clone()

Method new()

Create a new 'TableCellRanges' object.

Usage

TableCellRanges$new(parentTable)

Arguments

Returns

No return value.

Method addRange()

Add a cell range to the list of cell ranges. It is not necessary to specify all parameters. rFrom and cFrom must be specified. Only one of rSpan and rTo needs to be specified. Only one of cSpan and cTo needs to be specified.

Usage

TableCellRanges$addRange(
  rFrom = NULL,
  cFrom = NULL,
  rSpan = NULL,
  cSpan = NULL,
  rTo = NULL,
  cTo = NULL
)

Arguments

Returns

No return value.

Method findIntersectingRange()

Find a cell range in the list of cell ranges that intersects with the specified cell range. It is not necessary to specify all parameters. rFrom and cFrom must be specified. Only one of rSpan and rTo needs to be specified. Only one of cSpan and cTo needs to be specified.

Usage

TableCellRanges$findIntersectingRange(
  rFrom = NULL,
  cFrom = NULL,
  rSpan = NULL,
  cSpan = NULL,
  rTo = NULL,
  cTo = NULL
)

Arguments

Returns

No return value.

Method deleteRange()

Delete the cell range from the list that contains the specified cell.

Usage

TableCellRanges$deleteRange(r = NULL, c = NULL)

Arguments

Returns

No return value.

Method clear()

Clear the list of cell ranges.

Usage

TableCellRanges$clear()

Returns

No return value.

Method updateAfterRowInsert()

Internal use only.

Usage

TableCellRanges$updateAfterRowInsert(r = NULL)

Arguments

Returns

No return value.

Method updateAfterRowDelete()

Internal use only.

Usage

TableCellRanges$updateAfterRowDelete(r = NULL)

Arguments

Returns

No return value.

Method updateAfterColumnInsert()

Internal use only.

Usage

TableCellRanges$updateAfterColumnInsert(c = NULL)

Arguments

Returns

No return value.

Method updateAfterColumnDelete()

Internal use only.

Usage

TableCellRanges$updateAfterColumnDelete(c = NULL)

Arguments

Returns

No return value.

Method asList()

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

Usage

TableCellRanges$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

TableCellRanges$asJSON()

Returns

A JSON representation of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

TableCellRanges$clone(deep = FALSE)

Arguments

Examples

# TableCellRanges objects are never created outside of the BasicTable class.
# For examples of working with merged cells, see the Introduction vignette.

R6 class that manages cells in a table.

Description

The 'TableCells' manages the 'TableCell' objects that comprise a 'BasicTable' object.

Format

R6Class object.

Active bindings

Methods

Public methods

• TableCells$new()

• TableCells$reset()

• TableCells$getCell()

• TableCells$getValue()

• TableCells$getRowValues()

• TableCells$getColumnValues()

• TableCells$setCell()

• TableCells$setBlankCell()

• TableCells$deleteCell()

• TableCells$setValue()

• TableCells$setRow()

• TableCells$setColumn()

• TableCells$extendCells()

• TableCells$moveCell()

• TableCells$insertRow()

• TableCells$deleteRow()

• TableCells$insertColumn()

• TableCells$deleteColumn()

• TableCells$getCells()

• TableCells$findCells()

• TableCells$getColumnWidths()

• TableCells$asList()

• TableCells$asJSON()

• TableCells$clone()

Method new()

Create a new 'TableCells' object.

Usage

TableCells$new(parentTable = NULL)

Arguments

Returns

No return value.

Method reset()

Clear all cells from the table.

Usage

TableCells$reset()

Returns

No return value.

Method getCell()

Retrieve a specific 'TableCell' object at the specified location in the table.

Usage

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

Arguments

Returns

A 'TableCell' object.

Method getValue()

Retrieve the value of a specific 'TableCell' object at the specified location in the table.

Usage

TableCells$getValue(r = NULL, c = NULL, formattedValue = FALSE)

Arguments

Returns

The value of the cell.

Method getRowValues()

Get a vector or list of the values in a row for the entire row or a subset of columns.

Usage

TableCells$getRowValues(
  rowNumber = NULL,
  columnNumbers = NULL,
  formattedValue = FALSE,
  asList = FALSE,
  rebase = TRUE
)

Arguments

Returns

A vector or list of the cell values.

Method getColumnValues()

Get a vector or list of the values in a column for the entire column or a subset of rows.

Usage

TableCells$getColumnValues(
  columnNumber = NULL,
  rowNumbers = NULL,
  formattedValue = FALSE,
  asList = FALSE,
  rebase = TRUE
)

Arguments

Returns

A vector or list of the cell values.

Method setCell()

Create a cell in the table and set the details of the cell.

Usage

TableCells$setCell(
  r = NULL,
  c = NULL,
  cellType = "cell",
  rawValue = NULL,
  formattedValue = NULL,
  visible = TRUE,
  baseStyleName = NULL,
  styleDeclarations = NULL,
  rowSpan = NULL,
  colSpan = NULL
)

Arguments

Returns

A vector or list of the cell values.

Method setBlankCell()

Create an empty cell in the table and set the details of the cell.

Usage

TableCells$setBlankCell(
  r = NULL,
  c = NULL,
  cellType = "cell",
  visible = TRUE,
  baseStyleName = NULL,
  styleDeclarations = NULL,
  rowSpan = NULL,
  colSpan = NULL,
  asNBSP = FALSE
)

Arguments

Returns

A vector or list of the cell values.

Method deleteCell()

Replace the 'TableCell' object at the specified location in the table with a blank cell.

Usage

TableCells$deleteCell(r = NULL, c = NULL)

Arguments

Returns

The 'TableCell' object that is the new blank cell.

Method setValue()

Update the value of a cell in the table.

Usage

TableCells$setValue(r = NULL, c = NULL, rawValue = NULL, formattedValue = NULL)

Arguments

Returns

No return value.

Method setRow()

Create multiple cells in one row of a table.

Usage

TableCells$setRow(
  rowNumber = NULL,
  startAtColumnNumber = 1,
  cellTypes = "cell",
  rawValues = NULL,
  formattedValues = NULL,
  formats = NULL,
  visiblity = TRUE,
  baseStyleNames = NULL,
  fmtFuncArgs = NULL
)

Arguments

Returns

No return value.

Method setColumn()

Create multiple cells in one column of a table.

Usage

TableCells$setColumn(
  columnNumber = NULL,
  startAtRowNumber = 2,
  cellTypes = "cell",
  rawValues = NULL,
  formattedValues = NULL,
  formats = NULL,
  visiblity = TRUE,
  baseStyleNames = NULL,
  fmtFuncArgs = NULL
)

Arguments

Returns

No return value.

Method extendCells()

Enlarge a table to the specified size.

Usage

TableCells$extendCells(rowCount = NULL, columnCount = NULL)

Arguments

Returns

No return value.

Method moveCell()

Move a table cell to a different location in the table.

Usage

TableCells$moveCell(r = NULL, c = NULL, cell = NULL)

Arguments

Returns

No return value.

Method insertRow()

Insert a new row in the table at the specified row number and shift existing cells on/below this row down by one row.

Usage

TableCells$insertRow(
  rowNumber = NULL,
  insertBlankCells = TRUE,
  headerCells = 1,
  totalCells = 0
)

Arguments

Returns

No return value.

Method deleteRow()

Delete the row in the table at the specified row number and shift existing cells below this row up by one row.

Usage

TableCells$deleteRow(rowNumber = NULL)

Arguments

Returns

No return value.

Method insertColumn()

Insert a new column in the table at the specified column number and shift existing cells in/to the right of this column across by one row.

Usage

TableCells$insertColumn(
  columnNumber = NULL,
  insertBlankCells = TRUE,
  headerCells = 1,
  totalCells = 0
)

Arguments

Returns

No return value.

Method deleteColumn()

Delete the column in the table at the specified column number and shift existing cells to the right of this column to the left by one column.

Usage

TableCells$deleteColumn(columnNumber = NULL)

Arguments

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

TableCells$getCells(
  specifyCellsAsList = TRUE,
  rowNumbers = NULL,
  columnNumbers = NULL,
  cellCoordinates = NULL,
  excludeEmptyCells = FALSE,
  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 'TableCell' objects.

Method findCells()

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

Usage

TableCells$findCells(
  minValue = NULL,
  maxValue = NULL,
  exactValues = NULL,
  valueRanges = NULL,
  includeNull = TRUE,
  includeNA = TRUE,
  emptyCells = "include",
  rowNumbers = NULL,
  columnNumbers = NULL,
  cellCoordinates = NULL,
  cells = NULL,
  rowColumnMatchMode = "simple"
)

Arguments

Returns

A list of 'TableCell' objects.

Method getColumnWidths()

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

Usage

TableCells$getColumnWidths()

Returns

The width of the column in characters.

Method asList()

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

Usage

TableCells$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

TableCells$asJSON()

Returns

A JSON representation of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

TableCells$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by the table.
# It is not intended to be created outside of the table.
library(basictabler)
tbl <- qtbl(data.frame(a=1:2, b=3:4))
cells <- tbl$cells
cells$setCell(r=4, c=1, cellType="cell", rawValue=5)
cells$setCell(r=4, c=2, cellType="cell", rawValue=6)
tbl$renderTable()

R6 class that renders a table in HTML.

Description

The 'TableHtmlRenderer' class creates a HTML representation of a table.

Format

R6Class object.

Methods

Public methods

• TableHtmlRenderer$new()

• TableHtmlRenderer$getTableHtml()

• TableHtmlRenderer$clone()

Method new()

Create a new 'TableHtmlRenderer' object.

Usage

TableHtmlRenderer$new(parentTable)

Arguments

Returns

No return value.

Method getTableHtml()

Generate a HTML representation of the table.

Usage

TableHtmlRenderer$getTableHtml(styleNamePrefix = NULL)

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

TableHtmlRenderer$clone(deep = FALSE)

Arguments

Examples

# This class is for internal use only.  It is
# created only by the BasicTable class when rendering to HTML.
# See the package vignettes for more information about outputs.
library(basictabler)
tbl <- qtbl(data.frame(a=1:2, b=3:4))
tbl$renderTable()

R6 class that renders a table into an Excel worksheet.

Description

The 'TableOpenXlsxRenderer' class creates a representation of a table in an Excel file using the 'openxlsx' package. See the Excel Output vignette for more details.

Format

R6Class object.

Methods

Public methods

• TableOpenXlsxRenderer$new()

• TableOpenXlsxRenderer$writeToCell()

• TableOpenXlsxRenderer$writeToWorksheet()

• TableOpenXlsxRenderer$clone()

Method new()

Create a new 'TableOpenXlsxRenderer' object.

Usage

TableOpenXlsxRenderer$new(parentTable)

Arguments

Returns

No return value.

Method writeToCell()

Write a value to a cell, optionally with styling and cell merging.

Usage

TableOpenXlsxRenderer$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 a table to an Excel worksheet.

Usage

TableOpenXlsxRenderer$writeToWorksheet(
  wb = NULL,
  wsName = NULL,
  topRowNumber = NULL,
  leftMostColumnNumber = NULL,
  outputValuesAs = "rawValue",
  useFormattedValueIfRawValueIsNull = TRUE,
  applyStyles = TRUE,
  mapStylesFromCSS = TRUE
)

Arguments

Returns

No return value.

Method clone()

The objects of this class are cloneable with this method.

Usage

TableOpenXlsxRenderer$clone(deep = FALSE)

Arguments

Examples

# This class is for internal use only.  It is
# created only by the BasicTable class when rendering to Excel.
library(basictabler)
tbl <- qtbl(data.frame(a=1:2, b=3:4))
library(openxlsx)
wb <- createWorkbook(creator = Sys.getenv("USERNAME"))
addWorksheet(wb, "Data")
tbl$writeToExcelWorksheet(wb=wb, wsName="Data",
                         topRowNumber=1, leftMostColumnNumber=1,
                         applyStyles=TRUE, mapStylesFromCSS=TRUE)
# Use saveWorkbook() to save the Excel file.

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

Description

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

Format

R6Class object.

Active bindings

Methods

Public methods

• TableOpenXlsxStyle$new()

• TableOpenXlsxStyle$isBasicStyleNameMatch()

• TableOpenXlsxStyle$isFullStyleDetailMatch()

• TableOpenXlsxStyle$createOpenXslxStyle()

• TableOpenXlsxStyle$asList()

• TableOpenXlsxStyle$asJSON()

• TableOpenXlsxStyle$asString()

• TableOpenXlsxStyle$clone()

Method new()

Create a new 'TableOpenXlsxStyle' object.

Usage

TableOpenXlsxStyle$new(
  parentTable,
  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

No return value.

Method isBasicStyleNameMatch()

Check if this style matches the specified base style name.

Usage

TableOpenXlsxStyle$isBasicStyleNameMatch(baseStyleName = NULL)

Arguments

Returns

'TRUE' if the style name matches, 'FALSE' otherwise.

Method isFullStyleDetailMatch()

Check if this style matches the specified style properties.

Usage

TableOpenXlsxStyle$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

Returns

'TRUE' if the style matches, 'FALSE' otherwise.

Method createOpenXslxStyle()

Create the 'openxlsx' style based on the specified style properties.

Usage

TableOpenXlsxStyle$createOpenXslxStyle()

Returns

No return value.

Method asList()

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

Usage

TableOpenXlsxStyle$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

TableOpenXlsxStyle$asJSON()

Returns

A JSON representation of various object properties.

Method asString()

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

Usage

TableOpenXlsxStyle$asString()

Returns

A character representation of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

TableOpenXlsxStyle$clone(deep = FALSE)

Arguments

Examples

# This class should only be created by using the functions in the table.
# It is not intended to be created by users outside of the table.
library(basictabler)
tbl <- qtbl(data.frame(a=1:2, b=3:4))
library(openxlsx)
wb <- createWorkbook(creator = Sys.getenv("USERNAME"))
addWorksheet(wb, "Data")
tbl$writeToExcelWorksheet(wb=wb, wsName="Data",
                         topRowNumber=1, leftMostColumnNumber=1,
                         applyStyles=TRUE, mapStylesFromCSS=TRUE)
# Use saveWorkbook() to save the Excel file.

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

Description

The 'TableOpenXlsxStyles' class stores a collection of 'TableTableOpenXlsx' style objects.

Format

R6Class object.

Active bindings

Methods

Public methods

• TableOpenXlsxStyles$new()

• TableOpenXlsxStyles$clearStyles()

• TableOpenXlsxStyles$findNamedStyle()

• TableOpenXlsxStyles$findOrAddStyle()

• TableOpenXlsxStyles$addNamedStyles()

• TableOpenXlsxStyles$asList()

• TableOpenXlsxStyles$asJSON()

• TableOpenXlsxStyles$asString()

• TableOpenXlsxStyles$clone()

Method new()

Create a new 'TableOpenXlsxStyles' object.

Usage

TableOpenXlsxStyles$new(parentTable)

Arguments

Returns

No return value.

Method clearStyles()

Clear the collection removing all styles.

Usage

TableOpenXlsxStyles$clearStyles()

Returns

No return value.

Method findNamedStyle()

Find a style in the collection matching the specified base style name.

Usage

TableOpenXlsxStyles$findNamedStyle(baseStyleName)

Arguments

Returns

A 'TableTableOpenXlsx' object that is the style matching the specified base style name or 'NULL' otherwise.

Method findOrAddStyle()

Find a style in the collection matching the specified base style name and style properties. If there is no matching style, then optionally add a new style.

Usage

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

Arguments

Returns

A 'TableTableOpenXlsx' object that is the style matching the specified base style name or 'NULL' otherwise.

Method addNamedStyles()

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

Usage

TableOpenXlsxStyles$addNamedStyles(mapFromCss = TRUE)

Arguments

Returns

No return value.

Method asList()

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

Usage

TableOpenXlsxStyles$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

TableOpenXlsxStyles$asJSON()

Returns

A JSON representation of various object properties.

Method asString()

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

Usage

TableOpenXlsxStyles$asString(seperator = ", ")

Arguments

Returns

A character representation of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

TableOpenXlsxStyles$clone(deep = FALSE)

Arguments

Examples

# This class should not be used by end users.  It is an internal class
# created only by the BasicTable class.  It is used when rendering to Excel.
library(basictabler)
tbl <- qtbl(data.frame(a=1:2, b=3:4))
library(openxlsx)
wb <- createWorkbook(creator = Sys.getenv("USERNAME"))
addWorksheet(wb, "Data")
tbl$writeToExcelWorksheet(wb=wb, wsName="Data",
                         topRowNumber=1, leftMostColumnNumber=1,
                         applyStyles=TRUE, mapStylesFromCSS=TRUE)
# Use saveWorkbook() to save the Excel file.

R6 class that specifies styling.

Description

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

Format

R6Class object.

Active bindings

Methods

Public methods

• TableStyle$new()

• TableStyle$setPropertyValue()

• TableStyle$setPropertyValues()

• TableStyle$getPropertyValue()

• TableStyle$asCSSRule()

• TableStyle$asNamedCSSStyle()

• TableStyle$getCopy()

• TableStyle$asList()

• TableStyle$asJSON()

• TableStyle$clone()

Method new()

Create a new 'TableStyle' object.

Usage

TableStyle$new(parentTable, styleName = NULL, declarations = NULL)

Arguments

Returns

No return value.

Method setPropertyValue()

Set the value of a single style property.

Usage

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

Arguments

Returns

No return value.

Method setPropertyValues()

Set the values of multiple style properties.

Usage

TableStyle$setPropertyValues(declarations = NULL)

Arguments

Returns

No return value.

Method getPropertyValue()

Get the value of a single style property.

Usage

TableStyle$getPropertyValue(property = NULL)

Arguments

Returns

No return value.

Method asCSSRule()

Generate a CSS style rule from this table style.

Usage

TableStyle$asCSSRule(selector = NULL)

Arguments

Returns

The CSS style rule, e.g. { text-align: center; color: red; }

Method asNamedCSSStyle()

Generate a named CSS style from this table style.

Usage

TableStyle$asNamedCSSStyle(styleNamePrefix = NULL)

Arguments

Returns

The CSS style rule, e.g. cell { text-align: center; color: red; }

Method getCopy()

Create a copy of this 'TableStyle' object.

Usage

TableStyle$getCopy(newStyleName = NULL)

Arguments

Returns

The new 'TableStyle' object.

Method asList()

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

Usage

TableStyle$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

TableStyle$asJSON()

Returns

A JSON representation of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

TableStyle$clone(deep = FALSE)

Arguments

Examples

# TableStyle objects are normally created indirectly via one of the helper
# methods.
# For an example, see the `TableStyles` class.

R6 class that defines a collection of styles.

Description

The 'TableStyles' class defines all of the base styles needed to style/theme a table. It defines the names of the styles that are used for styling the different parts of the table.

Format

R6Class object.

Active bindings

Methods

Public methods

• TableStyles$new()

• TableStyles$isExistingStyle()

• TableStyles$getStyle()

• TableStyles$addStyle()

• TableStyles$copyStyle()

• TableStyles$asCSSRule()

• TableStyles$asNamedCSSStyle()

• TableStyles$asList()

• TableStyles$asJSON()

• TableStyles$asString()

• TableStyles$clone()

Method new()

Create a new 'TableStyles' object.

Usage

TableStyles$new(parentTable, themeName = NULL, allowExternalStyles = FALSE)

Arguments

Returns

No return value.

Method isExistingStyle()

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

Usage

TableStyles$isExistingStyle(styleName = NULL)

Arguments

Returns

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

Method getStyle()

Retrieve a style with the specified name from the collection.

Usage

TableStyles$getStyle(styleName = NULL)

Arguments

Returns

A 'TableStyle' object if a style with the specified name exists in the collection, an error is raised otherwise.

Method addStyle()

Add a new style to the collection of styles.

Usage

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

Arguments

Returns

The newly created 'TableStyle' object.

Method copyStyle()

Create a copy of an exist style.

Usage

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

Arguments

Returns

The newly created 'TableStyle' object.

Method asCSSRule()

Generate a CSS style rule from the specified table style.

Usage

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

Arguments

Returns

The CSS style rule, e.g. { text-align: center; color: red; }

Method asNamedCSSStyle()

Generate a named CSS style from the specified table style.

Usage

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

Arguments

Returns

The CSS style rule, e.g. cell { text-align: center; color: red; }

Method asList()

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

Usage

TableStyles$asList()

Returns

A list of various object properties.

Method asJSON()

Return the contents of this object as JSON for debugging.

Usage

TableStyles$asJSON()

Returns

A JSON representation of various object properties.

Method asString()

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

Usage

TableStyles$asString(seperator = ", ")

Arguments

Returns

A character representation of various object properties.

Method clone()

The objects of this class are cloneable with this method.

Usage

TableStyles$clone(deep = FALSE)

Arguments

Examples

# Creating styles is part of defining a theme for a table.
# Multiple styles must be created for each theme.
# The example below shows how to create one style.
# For an example of creating a full theme please
# see the Styling vignette.
tbl <- BasicTable$new()
# ...
TableStyles <- TableStyles$new(tbl, themeName="compact")
TableStyles$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"
  ))

Render a table as a HTML widget.

Description

The basictabler function is primarily intended for use with Shiny web applications.

Usage

basictabler(bt, width = NULL, height = NULL, styleNamePrefix = NULL)

Arguments

Value

A HTML widget.

Examples

# See the Shiny vignette in this package for an example.

Standard function for Shiny scaffolding.

Description

Standard function for Shiny scaffolding.

Usage

basictablerOutput(outputId, width = "100%", height = "100%")

Arguments

Examples

# See the Shiny vignette in this package for an example.

Generate a sample basic table.

Description

The basictablerSample function generates a sample basic table.

Usage

basictablerSample()

Value

Example basic table describing the performance of trains run by different train operating companies in Birmingham (UK).

Examples

# Generate sample table.
basictablerSample()

A Summary of Birmingham Trains, Dec 2016-Feb 2017.

Description

A dataset summarising all of the trains that either originated at, passed through or terminated at Birmingham New Street railway station in the UK between 1st December 2016 and 28th February 2017 inclusive.

Usage

bhmsummary

Format

A data frame with 4839 rows and 14 variables:

Status

Train status: A=Active, C=Cancelled, R=Reinstated

TOC

Train operating company

TrainCategory

Express Passenger or Ordinary Passenger

PowerType

DMU=Diesel Multiple Unit, EMU=Electrical Multiple Unit, HST=High Speed Train

SchedSpeedMPH

Scheduled maximum speed (in miles per hour)

GbttMonth

The month of the train in the Great Britain Train Timetable (GBTT)

GbttWeekDate

The week of the train in the Great Britain Train Timetable (GBTT)

Origin

3-letter code denoting the scheduled origin of the train

Destination

3-letter code denoting the scheduled destination of the train

TrainCount

The number of scheduled trains

OnTimeArrivals

The number of trains that arrived in Birmingham on time

OnTimeDepartures

The number of trains that departed Birmingham on time

TotalArrivalDelayMinutes

The total number of delay minutes for arrivals

TotalDepartureDelayMinutes

The total number of delay minutes for departures

Source

https://www.recenttraintimes.co.uk/

Perform basic checks on a function argument.

Description

checkArgument is a utility function that provides basic assurances about function argument values and generates standardised error messages when invalid values are encountered. This function should not be used outside the basictabler package.

Usage

checkArgument(
  argumentCheckMode,
  checkDataTypes,
  className,
  methodName,
  argumentValue,
  isMissing,
  allowMissing = FALSE,
  allowNull = FALSE,
  allowedClasses = NULL,
  mustBeAtomic = FALSE,
  allowedListElementClasses = NULL,
  listElementsMustBeAtomic = FALSE,
  allowedValues = NULL,
  minValue = NULL,
  maxValue = NULL,
  maxLength = NULL
)

Arguments

Value

No return value. If invalid values are encountered, the stop() function is used to interrupt execution.

Cleans up a CSS attribute value.

Description

cleanCssValue is a utility function that performs some basic cleanup on CSS attribute values. Leading and trailing whitespace is removed. The CSS values "initial" and "inherit" are blocked. The function is vectorised so can be used with arrays.

Usage

cleanCssValue(cssValue)

Arguments

Value

The cleaned value.

Check whether a text value is present in another text value.

Description

containsText is a utility function returns TRUE if one text value is present in another. Case sensitive. If textToSearch is a vector, returns TRUE if any element contains textToFind.

Usage

containsText(textToSearch, textToFind)

Arguments

Value

TRUE if the textToFind value is found.

Get an empty theme for applying no styling to a table.

Description

Get an empty theme for applying no styling to a table.

Usage

getBlankTblTheme(parentTable, themeName = "blank")

Arguments

Value

A TableStyles object.

Get the compact theme for styling a table.

Description

Get the compact theme for styling a table.

Usage

getCompactTblTheme(parentTable, themeName = "compact")

Arguments

Value

A TableStyles object.

Get the default theme for styling a table.

Description

Get the default theme for styling a table.

Usage

getDefaultTblTheme(parentTable, themeName = "default")

Arguments

Value

A TableStyles object.

Convert CSS border values to those used by the flextable package.

Description

getXlBorderFromCssBorder parses the CSS combined border declarations (i.e. border, border-left, border-right, border-top, border-bottom) and returns a list containing an openxlsx border style and color as separate elements.

Usage

getFtBorderFromCssBorder(text)

Arguments

Value

A list containing two elements: width, style and color.

Convert CSS border style values to those used by the flextable package.

Description

getFtBorderStyleFromCssBorder takes border parameters expressed as a list (must contain an element named style) and returns a border style that is compatible with the flextable package.

Usage

getFtBorderStyleFromCssBorder(border)

Arguments

Value

A flextable border style.

Convert CSS border width to those used by the flextable package.

Description

getFtBorderStyleFromCssBorder takes border parameters expressed as a list (must contain an element named style) and returns a border style that is compatible with the flextable package.

Usage

getFtBorderWidthFromCssBorder(border)

Arguments

Value

A flextable border style.

Get the large plain theme for styling a table.

Description

Get the large plain theme for styling a table.

Usage

getLargePlainTblTheme(parentTable, themeName = "largeplain")

Arguments

Value

A TableStyles object.

Find the first value in an array that is larger than the specified value.

Description

getNextPosition is a utility function that helps when parsing strings that contain delimiters.

Usage

getNextPosition(positions, afterPosition)

Arguments

Value

The first value in the array larger than afterPosition.

Get a simple coloured theme.

Description

Get a simple coloured theme that can be used to style a table into a custom colour scheme.

Usage

getSimpleColoredTblTheme(
  parentTable,
  themeName = "coloredTheme",
  colors = NULL,
  fontName = NULL,
  theme = NULL
)

Arguments

Value

A TableStyles object.

Examples

simpleOrangeTheme <- list(
  fontName="Verdana, Arial",
  fontSize="0.75em",
  headerBackgroundColor = "rgb(237, 125, 49)",
  headerColor = "rgb(255, 255, 255)",
  cellBackgroundColor = "rgb(255, 255, 255)",
  cellColor = "rgb(0, 0, 0)",
  totalBackgroundColor = "rgb(248, 198, 165)",
  totalColor = "rgb(0, 0, 0)",
  borderColor = "rgb(198, 89, 17)"
)
library(basictabler)
tbl <- qtbl(data.frame(a=1:2, b=3:4))
# then
tbl$theme <- simpleOrangeTheme
# or
theme <- getSimpleColoredTblTheme(tbl, theme=simpleOrangeTheme)
# make further changes to the theme
tbl$theme <- simpleOrangeTheme
# theme set, now render table
tbl$renderTable()

Get a built-in theme for styling a table.

Description

getTblTheme returns the specified theme.

Usage

getTblTheme(parentTable, themeName = NULL)

Arguments

Value

A TableStyles object.

Examples

library(basictabler)
tbl <- qtbl(data.frame(a=1:2, b=3:4))
tbl$theme <- getTblTheme(tbl, "largeplain")
tbl$renderTable()

Convert CSS border style values to those used by the openxlsx package.

Description

getXlBorderFromCssBorder parses the CSS combined border declarations (i.e. border, border-left, border-right, border-top, border-bottom) and returns a list containing an openxlsx border style and color as separate elements.

Usage

getXlBorderFromCssBorder(text)

Arguments

Value

A list containing two elements: style and color.

Convert CSS border values to those used by the openxlsx package.

Description

getXlBorderStyleFromCssBorder takes border parameters expressed as a list (containing elements: width and style) and returns a border style that is compatible with the openxlsx package.

Usage

getXlBorderStyleFromCssBorder(border)

Arguments

Value

An openxlsx border style.

Check whether a numeric value is present.

Description

isNumericValue is a utility function returns TRUE only when a numeric value is present. NULL, NA, numeric(0) and integer(0) all return FALSE.

Usage

isNumericValue(value)

Arguments

Value

TRUE if a numeric value is present.

Check whether a text value is present.

Description

isTextValue is a utility function returns TRUE only when a text value is present. NULL, NA, character(0) and "" all return FALSE.

Usage

isTextValue(value)

Arguments

Value

TRUE if a non-blank text value is present.

Convert a value of 1 to a NULL value.

Description

oneToNull is a utility function that returns NULL when a value of 0 or 1 is passed to it, otherwise it returns the original value.

Usage

oneToNULL(value, convertOneToNULL)

Arguments

Value

NULL if value==1, otherwise value.

Convert a CSS colour into a hex based colour code.

Description

parseColor converts a colour value specified in CSS to a hex based colour code. Example supported input values/formats/named colours are: #0080FF, rgb(0, 128, 255), rgba(0, 128, 255, 0.5) and red, green, etc.

Usage

parseColor(color)

Arguments

Value

The colour as a hex code, e.g. #FF00A0.

Parse a CSS border value.

Description

parseCssBorder parses the CSS combined border declarations (i.e. border, border-left, border-right, border-top, border-bottom) and returns a list containing the width, style and color as separate elements.

Usage

parseCssBorder(text)

Arguments

Value

A list containing three elements: width, style and color.

Convert a CSS size value into points.

Description

parseCssSizeToPt will take a CSS style and convert it to points. Supported input size units are in, cm, mm, pt, pc, px, em, are converted exactly: in, cm, mm, pt, pc: using 1in = 2.54cm = 25.4mm = 72pt = 6pc. The following are converted approximately: px, em, approx 1em=16px=12pt and 100

Usage

parseCssSizeToPt(size)

Arguments

Value

The size converted to points.

Convert a CSS size value into pixels

Description

parseCssSizeToPx will take a CSS style and convert it to pixels Supported input size units are in, cm, mm, pt, pc, px, em, are converted exactly: in, cm, mm, pt, pc: using 1in = 2.54cm = 25.4mm = 72pt = 6pc. The following are converted approximately: px, em, approx 1em=16px=12pt and 100

Usage

parseCssSizeToPx(size)

Arguments

Value

The size converted to pixels.

Split a CSS attribute value into a vector/array.

Description

parseCssString is a utility function that splits a string into a vector/array. The function pays attention to text qualifiers (single and double quotes) so won't split if the delimiter occurs inside a value.

Usage

parseCssString(text, separator = ",", removeEmptyString = TRUE)

Arguments

Value

An R vector containing the values from text split up.

Parse an ft-border value.

Description

parseFtBorder parses the combined ft border declarations (i.e. ft-border, ft-border-left, ft-border-right, ft-border-top, ft-border-bottom) and returns a list containing width, style and color as separate elements.

Usage

parseFtBorder(text)

Arguments

Value

A list containing two elements: width, style and color.

Parse an xl-border value.

Description

parseXlBorder parses the combined xl border declarations (i.e. xl-border, xl-border-left, xl-border-right, xl-border-top, xl-border-bottom) and returns a list containing style and color as separate elements.

Usage

parseXlBorder(text)

Arguments

Value

A list containing two elements: style and color.

Quickly render a basic table in HTML.

Description

The qhpvt function renders a basic table as a HTML widget with one line of R.

Usage

qhtbl(
  dataFrameOrMatrix,
  columnNamesAsColumnHeaders = TRUE,
  explicitColumnHeaders = NULL,
  rowNamesAsRowHeaders = FALSE,
  firstColumnAsRowHeaders = FALSE,
  explicitRowHeaders = NULL,
  numberOfColumnsAsRowHeaders = 0,
  columnFormats = NULL,
  columnCellTypes = NULL,
  theme = NULL,
  replaceExistingStyles = FALSE,
  tableStyle = NULL,
  headingStyle = NULL,
  cellStyle = NULL,
  totalStyle = NULL,
  ...
)

Arguments

Value

A basic table.

Examples

qhtbl(bhmsummary[1:5, c("GbttWeekDate", "Origin", "Destination", "TrainCount",
  "OnTimeArrivals")])
qhtbl(bhmsummary[1:5, c("GbttWeekDate", "Origin", "Destination", "TrainCount",
  "OnTimeArrivals")], columnNamesAsColumnHeaders=FALSE,
  explicitColumnHeaders=c("Week", "From", "To", "Trains", "On-Time"))

Quickly build a basic table.

Description

The qtbl function builds a basic table with one line of R.

Usage

qtbl(
  dataFrameOrMatrix,
  columnNamesAsColumnHeaders = TRUE,
  explicitColumnHeaders = NULL,
  rowNamesAsRowHeaders = FALSE,
  firstColumnAsRowHeaders = FALSE,
  explicitRowHeaders = NULL,
  numberOfColumnsAsRowHeaders = 0,
  columnFormats = NULL,
  columnCellTypes = NULL,
  theme = NULL,
  replaceExistingStyles = FALSE,
  tableStyle = NULL,
  headingStyle = NULL,
  cellStyle = NULL,
  totalStyle = NULL,
  ...
)

Arguments

Value

A basic table.

Examples

qtbl(bhmsummary[1:5, c("GbttWeekDate", "Origin", "Destination", "TrainCount",
  "OnTimeArrivals")])
qtbl(bhmsummary[1:5, c("GbttWeekDate", "Origin", "Destination", "TrainCount",
  "OnTimeArrivals")], columnNamesAsColumnHeaders=FALSE,
  explicitColumnHeaders=c("Week", "From", "To", "Trains", "On-Time"))

Standard function for Shiny scaffolding.

Description

Standard function for Shiny scaffolding.

Usage

renderBasictabler(expr, env = parent.frame(), quoted = FALSE)

Arguments

Examples

# See the Shiny vignette in this package for an example.

Train Stations

Description

A reference dataset listing the codes, names and locations of trains stations in Great Britain.

Usage

trainstations

Format

A data frame with 2568 rows and 7 variables:

CrsCode

3-letter code for the station

StationName

The name of the station

OsEasting

The UK Ordnance Survey Easting coordinate for the station

OsNorthing

The UK Ordnance Survey Northing coordinate for the station

GridReference

Grid reference for the station

Latitude

Latitude of the station location

Longitude

Longitude of the station location

Source

https://www.recenttraintimes.co.uk/

Convert a simple range expression to a standard R logical expression.

Description

vreConvertSimpleNumericRange is a utility function that converts a simple range expression of the form "value1<=v<value2" to a standard R logical expression of the form "value1<=v && v<value2".

Usage

vreConvertSimpleNumericRange(vre)

Arguments

Value

A standard R logical expression.

Read the value from a single-valued value range expression.

Description

vreGetSingleValue is a utility function reads the single value from a value range expression (it assumes the specified is either numeric, a number expressed as text or an expression of the form "v=" or "v==").

Usage

vreGetSingleValue(vre)

Arguments

Value

The value read from the expression.

Convert a colour in hex format (#RRGGBB) into a list.

Description

vreHexToClr converts a colour in hex format (#RRGGBB) into a list of three element (r, g and b).

Usage

vreHexToClr(hexclr)

Arguments

Value

The converted colour.

Test if two numeric values are equal within tolerance.

Description

vreIsEqual tests whether two values are equal within sqrt(.Machine$double.eps).

Usage

vreIsEqual(value1, value2)

Arguments

Value

'TRUE' if the two numbers are equal, 'FALSE' otherwise.

Test whether a value matches a value range expression.

Description

vreIsMatch tests a value (e.g. from a cell) matches the criteria specified in a value range expression.

Usage

vreIsMatch(vre, v, testOnly = FALSE)

Arguments

Value

'TRUE' if v matches the criteria specified in the value range expression, 'FALSE' otherwise.

Determine if a value range expression is a simple range expression.

Description

vreIsSingleValue is a utility function that returns 'TRUE' if the specified value range expression is a simple range expression of the form "value1<=v<value2", where the logical comparisons can be < or <= only and the values must be numbers.

Usage

vreIsSimpleNumericRange(vre)

Arguments

Value

'TRUE' if vre is a simple range expression, 'FALSE' otherwise.

Determine if a value range expression is a single value.

Description

vreIsSingleValue is a utility function that returns 'TRUE' if the specified value range expression is either numeric, a number expressed as text or an expression of the form "v=" or "v==".

Usage

vreIsSingleValue(vre)

Arguments

Value

'TRUE' if vre is a single value, 'FALSE' otherwise.

Scale a number from a range into a colour gradient.

Description

vreScale2Colours takes a value from a range and scales it proportionally into a colour from a colour gradient.

Usage

vreScale2Colours(clr1, clr2, vMin, vMax, value)

Arguments

Value

The value scaled into the target colour gradient.

Rescale a number from one range into another range.

Description

vreScaleNumber takes a value from one range and scales it proportionally into another range.

Usage

vreScaleNumber(n1, n2, vMin, vMax, value, decimalPlaces = 3)

Arguments

Value

The value rescaled into the target range.