dot-getMetadataEndpoint: getMetadataEndpoint

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

getMetadataEndpoint

Description

wrapper to getMetadata that retrieves a metadata endpoint

Usage

.getMetadataEndpoint(end_point, values, by, fields, d2_session, retry, verbose)

getCategories(values, by, fields, d2_session, retry, verbose)

getCatCombos(values, by, fields, d2_session, retry, verbose)

getCatOptionCombos(values, by, fields, d2_session, retry, verbose)

getCatOptionGroupSets(values, by, fields, d2_session, retry, verbose)

getCatOptionGroups(values, by, fields, d2_session, retry, verbose)

getCatOptions(values, by, fields, d2_session, retry, verbose)

getDataElementGroupSets(values, by, fields, d2_session, retry, verbose)

getDataElementGroups(values, by, fields, d2_session, retry, verbose)

getDataElements(values, by, fields, d2_session, retry, verbose)

getDataSets(values, by, fields, d2_session, retry, verbose)

getIndicatorGroupSets(values, by, fields, d2_session, retry, verbose)

getIndicatorGroups(values, by, fields, d2_session, retry, verbose)

getIndicators(values, by, fields, d2_session, retry, verbose)

getOptionGroupSets(values, by, fields, d2_session, retry, verbose)

getOptionGroups(values, by, fields, d2_session, retry, verbose)

getOptionSets(values, by, fields, d2_session, retry, verbose)

getOptions(values, by, fields, d2_session, retry, verbose)

getOrgUnitGroupSets(values, by, fields, d2_session, retry, verbose)

getOrgUnitGroups(values, by, fields, d2_session, retry, verbose)

getOrgUnits(values, by, fields, d2_session, retry, verbose)

getDimensions(values, by, fields, d2_session, retry, verbose)

getCategories(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getCatCombos(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getCatOptionCombos(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getCatOptionGroupSets(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getCatOptionGroups(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getCatOptions(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getDataElementGroupSets(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getDataElementGroups(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getDataElements(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getDataSets(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getUserGroups(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getIndicatorGroupSets(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getIndicatorGroups(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getIndicators(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getOptionGroupSets(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getOptionGroups(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getOptionSets(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getOptions(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getOrgUnitGroupSets(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getOrgUnitGroups(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getOrgUnits(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

getDimensions(
  values,
  by = "id",
  fields = NULL,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 1,
  verbose = FALSE,
  quiet = TRUE
)

Arguments

end_point	the endpoint to use
values	- string vector of identifiers that will be used in the filter e.g. vector of uids, names, or codes.
by	- what to filter by, i.e. id or name, default is id
fields	- the fields, which can come in any formt as long as all components are present
d2_session	the d2Session object, default is "d2_default_session", it will be made upon logining in to datim with loginToDATIM
retry	the number of times to try the call
verbose	return raw content with data

Value

the metadata response in json format and flattened

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