Learn R Programming

nprcgenekeepr (version 3.0.0)

checkRequiredCols: Check column names for required columns

Description

Check column names for required columns

Usage

checkRequiredCols(cols, reportErrors)

Value

NULL is returned if all required columns are present. See description of reportErrors for what happens when required columns are missing.

Arguments

cols

character vector of column names

reportErrors

logical value with no default. When TRUE and required columns are missing, a character vector of the names of the missing columns is returned. When FALSE and required columns are missing, the program stops with the error "Required field(s) missing: ...".

Details

When reportErrors = TRUE, NA entries in cols are treated as ordinary non-matching column names when building the list of missing required columns, rather than causing an error. (Earlier versions could error with "missing value where TRUE/FALSE needed" on such out-of-contract input.)

Examples

Run this code
library(nprcgenekeepr)
requiredCols <- getRequiredCols()
cols <- strsplit(
  paste0(
    "id,sire,siretype,dam,damtype,sex,numberofparentsknown,birth,",
    "arrivalatcenter,death,departure,status,ancestry,fromcenter?,",
    "origin"
  ),
  ","
)[[1L]]
checkRequiredCols(cols, reportErrors = TRUE) # NULL: all required present
# A missing required column is returned by name
checkRequiredCols(setdiff(cols, "birth"), reportErrors = TRUE)

Run the code above in your browser using DataLab