kobotools_api: Check kobotoolbox API and retrieve overall info about the...
In KoboconnectR: Download Data from Kobotoolbox to R

View source: R/Koboconnect.R

kobotools_api

R Documentation

Check kobotoolbox API and retrieve overall info about the projects/assets

Description

'kobotools_api' is a wrapper for kobotoolbox API 'https://[kpi-url]/api/v2/assets/'

Usage

kobotools_api(
  url = "eu.kobotoolbox.org",
  simplified = TRUE,
  uname = "",
  pwd = "",
  encoding = "UTF-8",
  qry = ""
)

Arguments

`url`	The '[kpi-url]' of kobotoolbox. Default is "eu.kobotoolbox.org"
`simplified`	A logical value, default is true
`uname`	takes the username
`pwd`	takes the password
`encoding`	is the encoding to be used. Default is "UTF-8".
`qry`	to add queries

Details

The function takes two variables. First one is 'url' which is the '[kpi-url]'. For most users it will be "eu.kobotoolbox.org" or "kf.kobotoolbox.org". Former is the default. The second parameter is 'simplified' which takes a logical value. If set to true, the function will return selected values from the parsed data and return a data frame. When set to false, a json will be returned with all the details.