assert_valid_queries: Verify if a Dataset Has the Required Format as Queries...

assert_valid_queriesR Documentation

Verify if a Dataset Has the Required Format as Queries Dataset.

Description

Verify if a Dataset Has the Required Format as Queries Dataset.

Usage

assert_valid_queries(queries, queries_name)

Arguments

queries

A data.frame.

queries_name

Name of the queries dataset, a string.

Details

Check if the dataset has the following columns

  • PREFIX, e.g., SMQ01, CQ12

  • GRPNAME, non NA, must be unique per each PREFIX

  • GRPID, could be NA, must be unique per each PREFIX

  • SCOPE, 'BROAD', 'NARROW', or NA

  • SCOPEN, 1, 2, or NA

  • SRCVAR, e.g., "AEDECOD", "AELLT", "AELLTCD", ...

  • TERMNAME, character, could be NA only at those observations where TERMID is non-NA

  • TERMID, integer, could be NA only at those observations where TERMNAME is non-NA

Value

The function throws an error if any of the requirements not met.

See Also

Other Advanced Functions: assert_db_requirements(), assert_terms(), extend_source_datasets(), filter_date_sources(), format.basket_select(), list_tte_source_objects(), params(), validate_basket_select(), validate_query()

Examples

data("queries")
assert_valid_queries(queries, "queries")

admiral documentation built on Oct. 19, 2023, 1:08 a.m.