Learn R
checkmate (version 1.7.2)

checkDataTable: Check if an argument is a data table

Description

Check if an argument is a data table

Usage

checkDataTable(x, key = NULL, index = NULL, types = character(0L),
  any.missing = TRUE, all.missing = TRUE, min.rows = NULL,
  min.cols = NULL, nrows = NULL, ncols = NULL, row.names = NULL,
  col.names = NULL)
assertDataTable(x, key = NULL, index = NULL, types = character(0L),
  any.missing = TRUE, all.missing = TRUE, min.rows = NULL,
  min.cols = NULL, nrows = NULL, ncols = NULL, row.names = NULL,
  col.names = NULL, add = NULL, .var.name)
assert_data_table(x, key = NULL, index = NULL, types = character(0L),
  any.missing = TRUE, all.missing = TRUE, min.rows = NULL,
  min.cols = NULL, nrows = NULL, ncols = NULL, row.names = NULL,
  col.names = NULL, add = NULL, .var.name)
testDataTable(x, key = NULL, index = NULL, types = character(0L),
  any.missing = TRUE, all.missing = TRUE, min.rows = NULL,
  min.cols = NULL, nrows = NULL, ncols = NULL, row.names = NULL,
  col.names = NULL)
test_data_table(x, key = NULL, index = NULL, types = character(0L),
  any.missing = TRUE, all.missing = TRUE, min.rows = NULL,
  min.cols = NULL, nrows = NULL, ncols = NULL, row.names = NULL,
  col.names = NULL)
expect_data_table(x, key = NULL, index = NULL, types = character(0L),
  any.missing = TRUE, all.missing = TRUE, min.rows = NULL,
  min.cols = NULL, nrows = NULL, ncols = NULL, row.names = NULL,
  col.names = NULL, info = NULL, label = NULL)

Arguments

x
[any] Object to check.
key
[character] Expected primary key(s) of the data table.
index
[character] Expected secondary key(s) of the data table.
types
[character] Character vector of class names. Each list element must inherit from at least one of the provided types. The types logical, integer, integerish, double, n
any.missing
[logical(1)] Are missing values allowed? Default is TRUE.
all.missing
[logical(1)] Are matrices with only missing values allowed? Default is TRUE.
min.rows
[integer(1)] Minimum number of rows.
min.cols
[integer(1)] Minimum number of columns.
nrows
[integer(1)] Exact number of rows.
ncols
[integer(1)] Exact number of columns.
row.names
[character(1)] Check for row names. Default is NULL (no check). See checkNamed for possible values. Note that you can use checkSubs
col.names
[character(1)] Check for column names. Default is NULL (no check). See checkNamed for possible values. Note that you can use checkS
add
[AssertCollection] Collection to store assertions. See AssertCollection.
.var.name
[character(1)] Name for x. Defaults to a heuristic to determine the name using deparse and substitute.
info
[character(1)] Extra information to be included in the message for the testthat reporter. See expect_that.
label
[character(1)] Same as .var.name, but passed down to expect_that.

Value

  • Depending on the function prefix: If the check is successful, the functions return TRUE. If the check is not successful, assertDataTable/assert_data_table throws an error message, testDataTable/test_data_table returns FALSE, and checkDataTable returns a string with the error message. The function expect_data_table always returns an expectation.

See Also

Other basetypes: checkArray, checkAtomicVector, checkAtomic, checkCharacter, checkComplex, checkDataFrame, checkEnvironment, checkFactor, checkFunction, checkIntegerish, checkInteger, checkList, checkLogical, checkMatrix, checkNumeric, checkVector

Examples

Run this code
library(data.table)
dt = as.data.table(iris)
setkeyv(dt, "Species")
setkeyv(dt, "Sepal.Length", physical = FALSE)
testDataTable(dt)
testDataTable(dt, key = "Species", index = "Sepal.Length", any.missing = FALSE)

Run the code above in your browser using DataCamp Workspace