Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rapidsurveys/okapi

Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools
https://github.com/rapidsurveys/okapi

capi kobotoolbox odk ona r

Last synced: about 2 months ago
JSON representation

Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools

Host: GitHub
URL: https://github.com/rapidsurveys/okapi
Owner: rapidsurveys
License: gpl-3.0
Created: 2019-09-07T04:21:05.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2024-03-13T23:24:32.000Z (9 months ago)
Last Synced: 2024-05-02T03:28:10.535Z (8 months ago)
Topics: capi, kobotoolbox, odk, ona, r
Language: R
Homepage: https://rapidsurveys.io/okapi/
Size: 5.3 MB
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 5
Metadata Files:
- Readme: README.Rmd
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        ---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# okapi: Open Data Kit (ODK)-based Computer-assisted Personal Interview (CAPI) Tools 

[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)

[![R-CMD-check](https://github.com/rapidsurveys/okapi/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rapidsurveys/okapi/actions/workflows/R-CMD-check.yaml)

[![test-coverage](https://github.com/rapidsurveys/okapi/workflows/test-coverage/badge.svg)](https://github.com/rapidsurveys/okapi/actions)

[![Codecov test coverage](https://codecov.io/gh/rapidsurveys/okapi/branch/main/graph/badge.svg)](https://codecov.io/gh/rapidsurveys/okapi?branch=main)

[![CodeFactor](https://www.codefactor.io/repository/github/rapidsurveys/okapi/badge)](https://www.codefactor.io/repository/github/rapidsurveys/okapi)

Data collection using computer-assisted personal interviewing or CAPI tools is now the standard approach for conducting surveys and studies. A wide range of CAPI systems are currently being used. The ability to interface with these systems helps in the overall data process. This package provides interface functions to CAPI systems based on the [Open Data Kit or ODK](https://getodk.org) technology.

## Motivation and development history

## The ODK ecosystem

## What does `okapi` do?

Currently, `okapi` provides functions to interface with two ODK-based systems: [ONA](https://getodk.org) and [KoboToolbox](https://kobotoolbox.org) via their respective APIs. The current set of functions perform the following tasks:

1. Authenticate with the respective servers using either an account password or an API token;

2. List resources in the server available to interface with; and,

3. Get data or resources from the server to [R](https://cran.r-project.org).

## Installation

`okapi` is not yet available on [CRAN](https://cran.r-project.org).

You can install `okapi` from the [RapidSurveys R Universe](https://rapidsurveys.r-universe.dev) with:

```{r install, echo = TRUE, eval = FALSE}

install.packages(

  "okapi", 

  repos = c(

    'https://rapidsurveys.r-universe.dev', 

    'https://cloud.r-project.org'

  )

)

```

## Usage

## Citation

If you find the `okapi` package useful, please cite using the suggested citation provided by a call to the `citation` function as follows:

```{r cite}

citation("okapi")

```

## Community guidelines

Feedback, bug reports and feature requests are welcome; file issues or seek support [here](https://github.com/rapidsurveys/okapi/issues). If you would like to contribute to the package, please see our [contributing guidelines](https://rapidsurveys.io/okapi/CONTRIBUTING.html).

This project is released with a [Contributor Code of Conduct](https://rapidsurveys.io/okapi/CODE_OF_CONDUCT.html). By participating in this project you agree to abide by its terms.