lookup_vocab_relationships: Lookup Vocabulary's Relationships

Description Usage Arguments Details See Also Examples

View source: R/x_vocabulary_relationships.R

Description

Lookup Vocabulary's Relationships

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
lookup_vocab_relationships(
  vocabulary_id,
  conn,
  conn_fun = "connectAthena()",
  vocab_schema = "omop_vocabulary",
  cache_only = FALSE,
  skip_cache = FALSE,
  override_cache = FALSE,
  render_sql = FALSE,
  render_only = FALSE,
  verbose = FALSE,
  sleepTime = 1
)

Arguments

vocabulary_id

Vector of 1 or more 'vocabulary_id' from the OMOP Vocabulary

conn

Connection object. If provided, diverts queries to the connection instead of the local Athena instance without caching features.

cache_only

Loads from the cache and does not query the database. A NULL object is returned if a resultset was not cached.

skip_cache

Skip the caching altogether and directly query the database.

override_cache

If TRUE, the cache will not be loaded and will be overwritten by a new query. For override_cache to take effect, skip_cache should be FALSE.

render_sql

If TRUE, the SQL will be printed back in the console prior to execution. Default: FALSE

verbose

If TRUE, prints loading and querying operations messages to the console. Default: FALSE

sleepTime

Argument for 'Sys.sleep()' in between queries to allow for halting function execution, especially in cases where other chariot functions are executing multiple queries in succession and require cancellation.

Details

Lookup all of a Vocabulary's non-null relationships in the Concept Relationship Table.

See Also

render

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
library(chariot)
library(tidyverse)

# Lookup relationships on the Vocabulary-Concept Class Id axis
vocab_lookup_relationships(vocabulary_id = "HemOnc")

# Relationships between HemOnc concepts only can also be looked up
vocab_lookup_intrarelation(vocabulary_id = "HemOnc")

# Relationships between HemOnc and non-Hemonc Concepts
vocab_lookup_interrelation(vocabulary_id = "HemOnc")

patelm9/chariot documentation built on Feb. 19, 2022, 11:29 a.m.