check_join: Check Join

In poissonconsulting/datacheckr: Data Checking

Description

Checks that the columns in a data frame form a many-to-one join with correponding columns in parent.

Usage

check_join(
  data,
  parent,
  join = NULL,
  referential = TRUE,
  extra = "Comments",
  ignore_nas = FALSE,
  data_name = substitute(data),
  parent_name = substitute(parent)
)

Arguments

data	The data frame to check.
parent	A data frame of the parent table.
join	A character vector of the join columns. Use a named character vector if the names of the columns differ.
referential	A flag indicating whether to check for referential integrity.
extra	A flag indicating whether to allow additional matching columns or a character vector of the names to allow.
ignore_nas	A flag indicating whether to ignore missing values or treat them as values.
data_name	A string of the name of data.
parent_name	A string of the name of parent.

Details

By default (join = NULL) all the columns in parent represent the join key.

Value

Throws an informative error or returns an invisible copy of data.

poissonconsulting/datacheckr documentation built on March 18, 2021, 10:37 a.m.