-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
63 lines (44 loc) · 3.72 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# squeacr: Semi-Quantitative Evaluation of Access and Coverage (SQUEAC) Tools in R <img src="man/figures/logo.png" width = "200" align="right" />
<!-- badges: start -->
[![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](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![R-CMD-check](https://github.com/nutriverse/squeacr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/nutriverse/squeacr/actions/workflows/R-CMD-check.yaml)
[![test-coverage](https://github.com/nutriverse/squeacr/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/nutriverse/squeacr/actions/workflows/test-coverage.yaml)
[![Codecov test coverage](https://codecov.io/gh/nutriverse/squeacr/branch/main/graph/badge.svg)](https://codecov.io/gh/nutriverse/squeacr?branch=main)
[![CodeFactor](https://www.codefactor.io/repository/github/nutriverse/squeacr/badge)](https://www.codefactor.io/repository/github/nutriverse/squeacr)
[![DOI](https://zenodo.org/badge/115501158.svg)](https://zenodo.org/badge/latestdoi/115501158)
<!-- badges: end -->
In the recent past, measurement of coverage has been mainly through two-stage cluster sampled surveys either as part of a nutrition assessment or through a specific coverage survey known as Centric Systematic Area Sampling (CSAS). However, such methods are resource intensive and often only used for final programme evaluation meaning results arrive too late for programme adaptation. SQUEAC, which stands for Semi-Quantitative Evaluation of Access and Coverage, is a low resource method designed specifically to address this limitation and is used regularly for monitoring, planning and importantly, timely improvement to programme quality, both for agency and Ministry of Health (MoH) led programmes. This package provides functions for use in conducting a SQUEAC investigation.
## Installation
The `squeacr` package is not yet available on [CRAN](https://cran.r-project.org) but can be installed from the [nutriverse R-universe](https://nutriverse.r-universe.dev) as follows:
```{r install, echo = TRUE, eval = FALSE}
install.packages(
"squeacr",
repos = c('https://nutriverse.r-universe.dev', 'https://cloud.r-project.org')
)
```
## What does `squeacr` do?
The `squeacr` package provides functions that facilitate the processing, analysis and reporting of various components of a SQUEAC investigation. The current version of the `squeacr` package currently provides the following:
* Functions to calculate CMAM programme performance metrics;
* Functions to calculate CMAM programme length of stay metrics; and,
* Functions to calculate CMAM coverage estimates.
## Citation
If you find the `squeacr` package useful, please cite using the suggested citation provided by a call to the `citation` function as follows:
```{r cite}
citation("squeacr")
```
## Community guidelines
Feedback, bug reports, and feature requests are welcome; file issues or seek support [here](https://github.com/nutriverse/squeacr/issues). If you would like to contribute to the package, please see our [contributing guidelines](https://nutriverse.io/squeacr/CONTRIBUTING.html).
This project is released with a [Contributor Code of Conduct](https://nutriverse.io/squeacr/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.