-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
61 lines (42 loc) · 2.94 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
---
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%"
)
```
# dietry: Utilities for Dietary Intake Indicators for Food Security Assessments <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: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![R-CMD-check](https://github.com/nutriverse/dietry/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/nutriverse/dietry/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/nutriverse/dietry/branch/main/graph/badge.svg)](https://app.codecov.io/gh/nutriverse/dietry?branch=main)
[![CodeFactor](https://www.codefactor.io/repository/github/nutriverse/dietry/badge)](https://www.codefactor.io/repository/github/nutriverse/dietry)
[![DOI](https://zenodo.org/badge/477273747.svg)](https://zenodo.org/badge/latestdoi/477273747)
<!-- badges: end -->
Food security assessments utilise several dietary intake indicators as proxy measures for diet quality, diet sufficiency, and food availability either at individual or household level. Utilities for recoding and calculating these indicators support in establishing consistent and reliable results.
## What does `dietry` do?
Currently, the `dietry` package has functions for:
* Cleaning, processing, scoring, and classifying the [Food Consumption Score](https://resources.vam.wfp.org/data-analysis/quantitative/food-security/food-consumption-score).
## Installation
The `dietry` package is still in active development and not yet available on [CRAN](https://cran.r-project.org/).
You can install the development version of `dietry` from the [nutriverse R Universe](https://nutriverse.r-universe.dev) with:
``` r
install.packages(
"dietry",
repos = c('https://nutriverse.r-universe.dev', 'https://cloud.r-project.org')
)
```
## Citation
If you find the `dietry` package useful, please cite using the suggested citation provided by a call to the `citation` function as follows:
```{r cite}
citation("dietry")
```
## Community guidelines
Feedback, bug reports, and feature requests are welcome; file issues or seek support [here](https://github.com/nutriverse/dietry/issues). If you would like to contribute to the package, please see our [contributing guidelines](https://nutriverse.io/dietry/CONTRIBUTING.html).
This project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.