check_db: Check user-specified database name and transforms it (if...

View source: R/db_get-helpers.R

check_dbR Documentation

Check user-specified database name and transforms it (if needed). If the user improperly specified a database, a message tells them how to fix it.

Description

Check user-specified database name and transforms it (if needed). If the user improperly specified a database, a message tells them how to fix it.

Usage

check_db(db, verbose = FALSE)

Arguments

db

A string specifying the database to query. Defaults to NULL, in which case the most recent database is queried. These names should be specified either as a four digit year (e.g., 1718) or as in the database, e.g., "ORExt1718" would query the 1718 database.

verbose

Do you want the format explained when acceptable, but non-exact matching strings, are used?

Value

Character vector — correctly formatted database name.

Examples

library(orextdb)
## Not run: 
check_db(db = current_db())

## End(Not run)

UO-BRT/orextdb documentation built on Jan. 29, 2023, 8:53 a.m.