getAnalytics: getAnalytics

In pepfar-datim/datimutils: Utilities for interacting with the DATIM api from R

getAnalytics

Description

calls the analytics endpoint

Usage

getAnalytics(
  ...,
  dx = NULL,
  dx_f = NULL,
  pe = NULL,
  pe_f = NULL,
  ou = NULL,
  ou_f = NULL,
  co = NULL,
  co_f = NULL,
  ao = NULL,
  ao_f = NULL,
  return_names = FALSE,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  timeout = 180,
  verbose = FALSE,
  quiet = TRUE
)

Arguments

...	any options here to tag on the end of the url to support all DHIS2 query parameters. may be specified as one or more strings (e.g. "startDate=2018-01-01&endDate=2018-06-01" or "startDate=2018-01-01", "endDate=2018-06-01") or as named variables, vectors, or lists [e.g. startDate = "2018-01-01", endDate = "2018-06-01" or c(startDate = "2018-01-01", endDate = "2018-06-01") or list(startDate = "2018-01-01", endDate = "2018-06-01")]
dx	dimensions dx
dx_f	filters dx
pe	dimensions pe
pe_f	filters pe
ou	dimensions ou
ou_f	filters f
co	dimensions co
co_f	filters co
ao	dimensions ao
ao_f	filters ao
return_names	FALSE for uids, TRUE for names
d2_session	the d2Session object, default is "d2_default_session", it will be made upon logining in to datim with loginToDATIM
retry	retry
verbose	return raw content with data
quiet	Echo the URL which is called to the console if TRUE.

Value

data frame with the rows of the response

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