d2Session: d2Session

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

d2Session

Description

d2Session

d2Session

Public fields

config_path

Path to a JSON configuration file.

base_url

The URL of the server, e.g. https://www.datim.org/.

username

Your user name.

user_orgunit

UID of the users assigned organisation unit

handle

An httr handle used to communicate with the DHIS2 instance.

me

dhis2 api/me response

max_cache_age

Maximum time responses should be cached

token

An httr OAUTH2 token

Methods

Public methods

• d2Session$new()

• d2Session$clone()

---

Method new()

Create a new DHISLogin object

Usage

d2Session$new(config_path = NA_character_, base_url, handle, me, token)

Arguments

config_path

Configuration file path

base_url

URL to the server.

handle

httr handle to be used for dhis2 connections

me

DHIS2 me response object

token

OAUTH2 token

---

Method clone()

The objects of this class are cloneable with this method.

Usage

d2Session$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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