get_organisations_by_level: Get Organisations by Level

In khisr: An R Client to Retrieve Data from DHIS2

Get Organisations by Level

Description

get_organisations_by_level() is an experimental function that retrieves the organisation units along with their parent units.

Usage

get_organisations_by_level(
  level = 1,
  org_ids = NULL,
  auth = NULL,
  call = caller_env()
)

Arguments

level	An integer specifying the desired organisation level (default level 1).
org_ids	Optional. A vector of organisation identifiers whose details are being retrieved.
auth	Optional. The authentication object
call	The call environment.

Value

A tibble containing the organisation units and their parent units up to the specified level.

Examples

# Fetch all the organisation units metadata
organisations <- get_organisations_by_level(level = 2)
organisations

khisr documentation built on Oct. 7, 2024, 1:11 a.m.