Skip to contents

Make sure that all column names are expected metadata columns. Checks across both req_meta_cols and optional_meta_cols.

Usage

precheck_col_invalid_meta(meta, verbose = FALSE, stop_on_error = FALSE)

Arguments

meta

A data frame of the metadata file

verbose

logical, if TRUE prints feedback messages to console for every test, if FALSE run silently

stop_on_error

logical, if TRUE will stop with an error if the result is "FAIL", and will throw genuine warning if result is "WARNING"

Value

a single row data frame

Examples

precheck_col_invalid_meta(example_meta)
#>              check result                                            message
#> 1 col_invalid_meta   PASS There are no invalid columns in the metadata file.
#>   guidance_url
#> 1           NA
precheck_col_invalid_meta(example_meta, verbose = TRUE)
#>  There are no invalid columns in the metadata file.
#>              check result                                            message
#> 1 col_invalid_meta   PASS There are no invalid columns in the metadata file.
#>   guidance_url
#> 1           NA