omopgenerics (version 1.4.1)

assertTable: Assert that an object is a table.

Description

Assert that an object is a table.

Usage

assertTable(
  x,
  class = NULL,
  numberColumns = NULL,
  numberRows = NULL,
  columns = character(),
  allowExtraColumns = TRUE,
  null = FALSE,
  empty = TRUE,
  unique = FALSE,
  nm = deparse1(substitute(x), backtick = TRUE),
  call = parent.frame(),
  msg = NULL
)

Arguments

x

Variable to check.

class

A class that the table must have: "tbl", "data.frame", "tbl_sql", ...

numberColumns

Number of columns that it has to contain.

numberRows

Number of rows that it has to contain.

columns

Name of the columns required.

allowExtraColumns

Whether extra columns are allowed.

null

Whether it can be NULL.

empty

Whether it can be empty.

unique

Whether it has to contain unique rows.

nm

Name to use in error messages. Defaults to the expression supplied to x.

call

Call argument that will be passed to cli.

msg

Custom error message.