check_data_item_version: Check the data item to ensure that it is valid for the...

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

Check the data item to ensure that it is valid for the version specified

Description

Currently, "B1610" is the only data item that no longer supports v1 and equally is the only data item that supports v2.

Usage

check_data_item_version(data_item, version = 1, silent = TRUE)

Arguments

data_item	character; the data item to check
version	character/numeric; the API version, either as a number (e.g. 1) or as a case-insensitive string (e.g. "v1" or "V2"). Default is 1.
silent	boolean; whether to show a warning if that version is not valid for the provided data item. Default is TRUE.

Value

boolean; returns TRUE if data_item is valid for the provided version, FALSE if it is not

Examples

check_data_item_version("B1610", 1)
check_data_item_version("B1710", 1)

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