kpi_get_xlsform: Fetch the XLSForm for a survey with asset ID 'asset_id'

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

Fetch the XLSForm for a survey with asset ID asset_id

Description

Downloads the current XLSForm for a survey with ID asset_id.

Usage

kpi_get_xlsform(asset_id, file = NULL, verbose = TRUE)

Arguments

asset_id	The survey's asset ID (found after the "/forms/" in the URL)
file	If not NULL, the path where the XLSForm should be saved
verbose	If TRUE, echos a message where the file was saved

Value

An odk_xlsform object, a list() with id, survey, choices, and settings entries.

Examples

## Not run: 
# Form url is this: https://kf.kobotoolbox.org/#/forms/abcdefghijklmnop
# Asset ID is: abcdefghijklmnop
form <- karpi::kpi_get_xlsform("abcdefghijklmnop")
print(form$survey)
print(form$choices)

## End(Not run)

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