FormatForApi_Dimensions: FormatForApi_Dimensions(data, type_col, dim_id_col,...

In pepfar-datim/data-pack-commons: Common Utilities for with with the PEPFAR DataPack

FormatForApi_Dimensions(data, type_col, dim_id_col, item_id_col)

Description

Uses specified columns in a data from to produce APIrequest formated dimensions e.g. &dimension=dim-id:dim-item;dim-item Only includes unique dimension, dim-id, dim-item tupples

Usage

FormatForApi_Dimensions(data, type_col, dim_id_col, item_id_col)

Arguments

data	dataframe - containing parameters to incorporate into api call
type_col	string - name of column in data that specifies "dimension" or "filter"
dim_id_col	string - name of column in data that specifies dimension ids - including dx, ou, etc.
item_id_col	string - name of column in data that specifies dimension item ids

Value

string ready for api call such as "dimension=dim-id:dim-item;dim-item&filter=dim-id:dim-item;dim-item" Note there is no leading "&" in string

Examples

df = tibble::tribble(~type, ~dim_id, ~item_id, ~other_col,
"dimension",    "LFsZ8v5v7rq", "CW81uF03hvV",
"Implementing Partner: AIDSRelief Consortium",
"dimension",    "LFsZ8v5v7rq", "C6nZpLKjEJr",
"Implementing Partner: African Medical and Research Foundation",
"filter", "dx", "BOSZApCrBni", "ART enrollment stage 1",
"filter", "dx", "dGdeotKpRed", "ART enrollment stage 2",
"dimension", "ou", "O6uvpzGd5pu", "Bo",
"filter", "pe", "THIS_FINANCIAL_YEAR","")
FormatForApi_Dimensions(df, "type", "dim_id", "item_id")

pepfar-datim/data-pack-commons documentation built on Feb. 6, 2024, 9:46 p.m.