get_terms_from_db {admiral}R Documentation

Get Terms from the Queries Database

Description

The function checks if all requirements to access the database are fulfilled (version and access function are available, see assert_db_requirements()), reads the terms from the database, and checks if the dataset with the terms is in the expected format (see assert_terms()).

Usage

get_terms_from_db(
  version,
  fun,
  queries,
  definition,
  expect_query_name = FALSE,
  expect_query_id = FALSE,
  i,
  temp_env,
  type
)

Arguments

version

Version

The version must be non null. Otherwise, an error is issued. The value is passed to the access function (fun).

fun

Access function

The access function must be non null. Otherwise, an error is issued. The function is called to retrieve the terms.

queries

Queries

List of all queries passed to create_query_data(). It is used for error messages.

definition

Definition of the query

The definition is passed to the access function. It defines which terms are returned.

expect_query_name

Is QUERY_NAME expected in the output dataset?

expect_query_id

Is QUERY_ID expected in the output dataset?

i

Index of definition in queries

The value is used for error messages.

temp_env

Temporary environment

The value is passed to the access function.

type

Type of query

Permitted Values: "smq", "sdg"

Value

Output dataset of the access function

Author(s)

Stefan Bundfuss

See Also

OCCDS Functions: create_query_data(), create_single_dose_dataset(), derive_vars_atc(), derive_vars_query()


[Package admiral version 0.8.4 Index]