kpi_set_url: Set KPI host domain

In nyuglobalties/karpi: Direct R interface to the KoBo v2 API

Set KPI host domain

Description

karpi supports the kobotoolbox (kf) and humanitarian (kc) domains by default. To point to another KPI domain, set type to "custom" and set domain to the domain URL. Setting the URL overwrites the "kpi.urlroot" option.

Usage

kpi_set_url(type = "kobotoolbox", domain = NULL)

Arguments

type	Which KPI platform to use - one of "kobotoolbox", "humanitarian", or "custom"
domain	Domain URL for "custom" type platform

Value

The KPI domain URL

Default KPI domains

KoBo has two domains for use:

1. kobotoolbox (kf.kobotoolbox.org): General purpose KoBo deployments on KoBo

2. humanitarian (kc.kobotoolbox.info): Unrestricted KoBo platform used by humanitarian agencies (e.g. UNICEF)

nyuglobalties/karpi documentation built on July 8, 2023, 1:38 a.m.