getDataStoreKey: getDataStoreKey returns a particular key from the datastore

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

getDataStoreKey returns a particular key from the datastore

Description

The DHIS2 datastore can be used to store arbitrary JSON objects.

Usage

getDataStoreKey(
  namespace,
  key,
  simplify = FALSE,
  d2_session = dynGet("d2_default_session", inherits = TRUE),
  retry = 3,
  timeout = 60
)

Arguments

namespace	Namespace of the datastore
key	Key of the datastore
simplify	Should the JSON response be simplified?
d2_session	the d2Session object, default is "d2_default_session", it will be made upon login in to DATIM with loginToDATIM
retry	Number of times to retry the request
timeout	Timeout in number of seconds

Value

A list if the request is successful. A data frame may be returned if the simiplify paramater is set to TRUE, but it depends on the intrinsic structure of the key itself.

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