join: Join a R dataframe to Athena's concept table

Description Usage Arguments

Description

This function has better performance than the WHERE IN statement for larger searches. A table in the format of "vunpunctuated timestamp" is written to the local Athena. A join is performed with a concept table. The table is subsequently dropped. If a dataframe column is not provided as a the column to join the concept table on, the 1st column will be used by default.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
join(
  kind = c("LEFT", "RIGHT", "INNER", "FULL"),
  data,
  column = NULL,
  vocab_table,
  vocab_field,
  select_data_columns = "*",
  select_vocab_fields = "*",
  distinct = FALSE,
  write_schema = "patelm9",
  vocab_schema = "omop_vocabulary",
  where_in_vocab_field,
  where_in_vocab_field_value,
  where_not_in_vocab_field,
  where_not_in_vocab_field_value,
  where_is_null_vocab_field,
  where_is_not_null_vocab_field,
  case_insensitive = TRUE,
  conn,
  conn_fun = "connectAthena()",
  verbose = TRUE,
  render_sql = TRUE,
  render_only = FALSE
)

Arguments

data

dataframe to join

column

string of the column name to join on. If NULL, the 1st column is used.

vocab_table

OMOP Vocabulary table to join to

select_data_columns

Vector of field names in the 'data' to select for.

select_vocab_fields

Vector of field names in the 'vocab_table' to select for.

distinct

Will the resultset contain only distinct rows?

write_schema

Schema in the database with write permissions to write the table containing 'data' to. This table is dropped on exit.

vocab_schema

Schema containing the OMOP Vocabulary tables.

vocab_column

Field in the 'vocab_table' to join on.


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