getSqlView: getSqlView

View source: R/getSqlView.R

getSqlViewR Documentation

getSqlView

Description

Runs specified sql view with specified sql view variables and returns a tibble with the results. It is possible to specify the col_types when reading in the data

Usage

getSqlView(
  ...,
  sql_view_uid,
  variable_keys = NULL,
  variable_values = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  timeout = 180,
  verbose = FALSE,
  quiet = TRUE
)

Arguments

...

any filters to be used get put in here

sql_view_uid

chr - the uid of the sql view

variable_keys

character list - list of the variable names for the sql view

variable_values

character list - list of the variable values ordered to correspond with the related variable key

d2_session

the d2Session object, default is "d2_default_session", it will be made upon logging in to datim with loginToDATIM

retry

number of times to retry

timeout

number of seconds to wait during call

verbose

return raw content with data

quiet

Echo the URL which is called if TRUE.

Value

dataframe with the results of the sql view


pepfar-datim/datimutils documentation built on Nov. 20, 2023, 7:58 a.m.