Skip to contents

Get a KoboToolbox survey form

Source: R/kobo_form.R
kobo_form.Rd

Get a KoboToolbox survey form from a kobo_asset or an asset unique identifier.

Usage

kobo_form(x, version)

Arguments

x

the unique identifier of a specific asset (character) or a kobo_asset object.

version

character, the unique identifier of the version of the asset.

Value

A data.frame with the following columns:

  • name the name of the survey questions

  • list_name the name of list of code used for values and labels

  • type the type of KoboToolbox survey questions

  • label the label of the questions

  • lang the languages used in the survey

  • version the survey version unique identifier

  • choices a list column with the choices values and labels

  • kuid the unique identifier of the question

  • qpath and xpath the path of the question in JSON/XML

You can also have other columns such as relevant, calculation, etc. depending on how you structure for survey form.

Examples

if (FALSE) { # \dontrun{
# Use your own URL and token
kobo_setup(url = "https://kf.kobotoolbox.org/",
           token = "9et1814c285w094f6v9bd629df47a1a0e81x53a0")
# Use your own API asset identifier
uid <- "a9cwEQcbWqWzA5hzkjRUWi"
asset <- kobo_asset(uid)
form <- kobo_form(asset)
} # }