kobotools_kpi_data: Extract data from kobotoolbox

View source: R/Koboconnect.R

kobotools_kpi_dataR Documentation

Extract data from kobotoolbox

Description

'kobotools_kpi_data' is a wrapper for kobotoolbox API 'https://[URL]/api/v2/assets/[assetid]/data/'

Usage

kobotools_kpi_data(
  assetid,
  url = "eu.kobotoolbox.org",
  uname = "",
  pwd = "",
  encoding = "UTF-8",
  format = "json"
)

Arguments

assetid

is the asset id of the asset for which the data is to be downloaded. The id can be found by running [kobotools_data_list_kc()]

url

The '[kpi-url]' of kobotoolbox. Default is "eu.kobotoolbox.org"

uname

is username of your kobotoolbox account

pwd

is the password of the account

encoding

is the encoding to be used. Default is "UTF-8".

format

lets you define the format of output for e.g. json or xml

Details

The function takes the url as one of the inputs. And asset id as another. Both are strings. The asset id is found by running the [kobotools_api()] function.Other parameters are username and password.

Value

The function returns the data in json format


KoboconnectR documentation built on Sept. 11, 2024, 8:07 p.m.