Check if column names exceed a character limit

Uses the api_char_limit function to check if any column names in the provided data frame exceed the character limit specified in the api_char_limits data frame.

Usage

check_api_char_col_name(data, verbose = FALSE, stop_on_error = FALSE)

Arguments

data

A data frame of the data 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

See also

Other check_api: check_api_char_col_label(), check_api_char_filter_items(), check_api_char_loc_code()

Examples

check_api_char_col_name(example_data)
#>               check result
#> 1 api_char_col_name   PASS
#>                                                                             message
#> 1 All filter / indicator names are less than or equal to the character limit of 50.
#>   guidance_url
#> 1           NA