library(KoboconnectR) #> Extract Kobotools data to R
library(KoboconnectR) get_kobo_token(url="kobo.humanitarianresponse.info", uname="userid", pwd="password")
The output is usually like this
No encoding supplied: defaulting to UTF-8. $token  "nask976bdshuiqw9829nsh718"
Extracting data is two step process. Step one is to identify the asset id. And next is to use the asset id to extract the data.
kobotools_api(url="kobo.humanitarianresponse.info", simplified=T, uname="userid", pwd="password")
The output will be a simplified data frame if
simplified =T is used in the
From the data frame, you can find the asset id you need ((under the
Use the asset id and plug in to the
function to download the data.
kobotools_kpi_data(assetid= "assetid", url="kobo.humanitarianresponse.info", uname="username", pwd="password")
This returns a list from json file. Main data is usually inside
Following shows the summary of the list downloaded from one
Downloading: 8.4 kB Length Class Mode count 1 -none- numeric next 0 -none- NULL previous 0 -none- NULL results 39 -none- list
‘Kobotoolbox’ provides ability to create export of survey results. These exports can be of different formats including ‘csv’ and ‘xls’. The manual process is mentioned the documentation.
Using ‘kobo_exports()’ function, you can view the list of existing exports. This includes URL to the ‘xls’ or ‘csv’ file that you can use to download, import or read files in R.
kobo_exports(url="kobo.humanitarianresponse.info", uname="", pwd="")
Exported data is not updated automatically when new data is entered in the survey. So, you may need to create new export to accommodate new data. To create export, use ‘kobo_export_create()’ function. Please note that ‘Kobotoolbox’ has a limited memory and you may have to delete existing exports manually to clean up.
kobo_export_create(url="kobo.humanitarianresponse.info", uname="", pwd="", assetid="", type= "csv", all="false", lang="_default", hierarchy="false", include_grp="true",grp_sep="/")
On successful execution, the URL of the created export will be returned and printed. You can use this URL to download, import or read data in R.
Find dummy example of how to create export and download csv from Kobotoolbox to R here
This is a new function which
kobo_df_download(uname = "username",pwd="password", assetid = "asset", lang = "English (en)")
Works on the same principle as that in
except the exported file is in
kobo_xls_dl(uname = "username",pwd="password", assetid = "asset", lang = "English (en)")
This function downloads the file using
then finds the columns with media links and then downloads the files in
a loop. This process is time consuming and you may face errors due to
timeouts and server load issues.
kobo_media_downloader(uname = "uid",pwd="password", assetid = "assetid")
In case do not want to use this function, use the data downloaded
kobo_df_download and find the columns where media
links exist. Then loop over the values in the column (download using the
Please feel free to add issue of suggestions in github