data_frame_compare_structure: Verify equivalent structure of two dataset

In OuhscBbmc/OuhscMunge: Data Manipulation Operations

Verify equivalent structure of two dataset

Description

Compare two datasets and throw an error if they have different (a) column counts, (b) column names, and (c) column class

Usage

data_frame_compare_structure(d_original, d_current, datestamp_ignore = FALSE)

Arguments

d_original	A data.frame that serves as the existing metadata file that potentially needs to be updated. Required.
d_current	A data.frame that contains records potentially missing from d_original. Required.
datestamp_ignore	A logical value indicating whether to ignore a column called datestamp. Defaults to FALSE.

Value

If all check pass, and invisible TRUE is returned.

Note

The datestamp column is used in metadata operations like metadata_update_file() and data_frame_stack_new(). In these functions, the datestamp column does not have to be present.

Author(s)

Will Beasley

Examples

# A conventional comparison.
ds_original_1 <- tibble::tibble(
  x1  = c(1, 3, 4),
  x2  = letters[c(1, 3, 4)],
  x3  = c(11, 13, 14)
)
ds_current <- tibble::tibble(
  x1  = c(1:5, 1, 5),
  x2  = c(letters[1:5], "x", "y"),
  x3  = c(11, 12, 13, 14, 15, 11, 15)
)
data_frame_compare_structure(ds_original_1, ds_current)

# When comparing metadata w/ datestamp.
ds_original_2 <- tibble::tibble(
  x1  = c(1, 3, 4),
  x2  = letters[c(1, 3, 4)],
  x3  = c(11, 13, 14),
  datestamp = Sys.Date()
)
data_frame_compare_structure(ds_original_2, ds_current, datestamp_ignore = TRUE)

OuhscBbmc/OuhscMunge documentation built on Dec. 5, 2024, 4:34 a.m.