README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{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 <img src="man/figures/logo.png" width="200" align="right" />

<!-- badges: start -->
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![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)
[![DOI](https://zenodo.org/badge/206914853.svg)](https://zenodo.org/badge/latestdoi/206914853)
<!-- badges: end -->

Data collection using computer-assisted personal interviewing (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 (ODK)](https://getodk.org) technology.

<!-- ## Motivation and development history

## The ODK ecosystem -->

## What does the package do?

Currently, `{okapi}` provides functions to interface with [ONA](https://getodk.org) via its [API](https://api.ona.io/static/docs/index.html). 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 on [CRAN](https://cran.r-project.org) but can be installed 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

### Authentication

### List resources

### Retrieve resources

## Citation

If you use `{okapi}` in your work, 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.