check_data_item: Check the data item to ensure that it is a valid request

In ARawles/BMRSr: Wrapper Functions to the 'BMRS API'

Check the data item to ensure that it is a valid request

Description

Check the data item to ensure that it is a valid request

Usage

check_data_item(
  data_item,
  type = c("any", "B Flow", "Legacy", "REMIT"),
  silent = FALSE
)

Arguments

data_item	character; the data item to check
type	character; the type of data_item - one of "B Flow", "Legacy", or "REMIT" or "any" for any type
silent	boolean; whether to show a warning if not a valid data item

Value

boolean: returns true if data_item is valid, false if it is not

Examples

check_data_item("B1720", "B Flow") #valid
check_data_item("B1720", "Legacy") #invalid - incorrect type
check_data_item("B1111", "REMIT") #invalid - incorrect data item and type

ARawles/BMRSr documentation built on Feb. 1, 2023, 12:11 p.m.