Skip to content

Commit

Permalink
update README; add badges
Browse files Browse the repository at this point in the history
  • Loading branch information
@ernestguevarra
ernestguevarra committed Oct 21, 2024
1 parent 9d4d934 commit f2ff6d1
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 24 deletions.
2 changes: 2 additions & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,5 @@ docs
/vignettes/plausibility_files/
/vignettes/prevalence_files/
/vignettes/sample_size_files/

/.quarto/
28 changes: 17 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,16 @@

<!-- badges: start -->

[![R-CMD-check](https://github.com/nutriverse/mwana/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tomaszaba/ipccheckr/actions/workflows/R-CMD-check.yaml)
[![Codecov test
coverage](https://codecov.io/gh/nutriverse/mwana/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tomaszaba/ipccheckr?branch=main)
[![Lifecycle:
experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![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)
[![pages-build-deployment](https://github.com/nutriverse/mwana/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/nutriverse/mwana/actions/workflows/pages/pages-build-deployment)
[![R-CMD-check](https://github.com/nutriverse/mwana/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/nutriverse/mwana/actions/workflows/R-CMD-check.yaml)
[![test-coverage](https://github.com/nutriverse/mwana/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/nutriverse/mwana/actions/workflows/test-coverage.yaml)
[![codecov](https://codecov.io/gh/nutriverse/mwana/graph/badge.svg?token=kUUp1WOlSi)](https://codecov.io/gh/nutriverse/mwana)
[![CodeFactor](https://www.codefactor.io/repository/github/nutriverse/mwana/badge.png)](https://www.codefactor.io/repository/github/nutriverse/mwana)
<!-- badges: end -->

Child anthropometric assessments, implemented routinely in most
Expand Down Expand Up @@ -54,7 +56,7 @@ process particularly when handling large multiple datasets.
>
> `mwana` was made possible thanks to the state-of-the-art work in
> nutrition survey guidance led by the [SMART
> initiative](https://smartmethodology.org). Under to hood, `mwana`
> initiative](https://smartmethodology.org). Under the hood, `mwana`
> bundles the SMART guidance through the use of the National Information
> Platforms for Nutrition Anthropometric Data Toolkit (nipnTK)
> functionalities in `R` to build its handy function around plausibility
Expand Down Expand Up @@ -82,7 +84,9 @@ summaries of the outputs.

#### A useful workflow for plausibility check using `mwana`

<img src="README_files/figure-commonmark/worflow-1.png"
PhantomJS not found. You can install it with webshot::install_phantomjs(). If it is installed, please make sure the phantomjs executable can be found via the PATH variable.

<img src="README_files/figure-commonmark/workflow-1.png"
data-fig-align="center" />

### Prevalence analysis
Expand Down Expand Up @@ -136,12 +140,14 @@ sites. (Check out the vignette).
## Installation

`mwana` is not yet on CRAN but you can install the development version
from [nutriverse R universe](https://nutriverse.r-universe.dev) as
follows:
`mwana` is not yet on CRAN but can be installed fromthe [nutriverse R
Universe](https://nutriverse.r-universe.dev) as follows:

``` r
remotes::install_github("tomaszaba/ipccheckr")
install.packages(
"mwana",
repos = c('https://nutriverse.r-universe.dev', 'https://cloud.r-project.org')
)
```

Then load to in memory with
Expand Down
22 changes: 14 additions & 8 deletions README.qmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,13 @@ library(ipccheckr)
# `mwana`: Utilities for analysing children's nutritional status

<!-- badges: start -->
[![R-CMD-check](https://github.com/nutriverse/mwana/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tomaszaba/ipccheckr/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/nutriverse/mwana/branch/main/graph/badge.svg)](https://app.codecov.io/gh/tomaszaba/ipccheckr?branch=main)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![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)
[![pages-build-deployment](https://github.com/nutriverse/mwana/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/nutriverse/mwana/actions/workflows/pages/pages-build-deployment)
[![R-CMD-check](https://github.com/nutriverse/mwana/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/nutriverse/mwana/actions/workflows/R-CMD-check.yaml)
[![test-coverage](https://github.com/nutriverse/mwana/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/nutriverse/mwana/actions/workflows/test-coverage.yaml)
[![codecov](https://codecov.io/gh/nutriverse/mwana/graph/badge.svg?token=kUUp1WOlSi)](https://codecov.io/gh/nutriverse/mwana)
[![CodeFactor](https://www.codefactor.io/repository/github/nutriverse/mwana/badge)](https://www.codefactor.io/repository/github/nutriverse/mwana)
<!-- badges: end -->

Child anthropometric assessments, implemented routinely in most countries worldwide, are the cornerstones of child nutrition and food security surveillance around the world. Ensuring the quality of child anthropometric data, the accuracy of child undernutrition prevalence estimates, and the timeliness of reporting is therefore critical in establishing accurate, robust, and up-to-date child undernutrition status globally.
Expand All @@ -32,7 +35,7 @@ Child anthropometric assessments, implemented routinely in most countries worldw
`mwana`, which is primarily an R-based implementation of the ENA for SMART software, simplifies this cumbersome workflow into a programmable process particularly when handling large multiple datasets.

:::{.callout-note}
`mwana` was made possible thanks to the state-of-the-art work in nutrition survey guidance led by the [SMART initiative](https://smartmethodology.org). Under to hood, `mwana` bundles the SMART guidance through the use of the National Information Platforms for Nutrition Anthropometric Data Toolkit (nipnTK) functionalities in `R` to build its handy function around plausibility checks. Click [here](https://github.com/nutriverse/nipnTK) to learn more about the `nipnTK` package.
`mwana` was made possible thanks to the state-of-the-art work in nutrition survey guidance led by the [SMART initiative](https://smartmethodology.org). Under the hood, `mwana` bundles the SMART guidance through the use of the National Information Platforms for Nutrition Anthropometric Data Toolkit (nipnTK) functionalities in `R` to build its handy function around plausibility checks. Click [here](https://github.com/nutriverse/nipnTK) to learn more about the `nipnTK` package.
:::

## What does `mwana` do?
Expand All @@ -47,7 +50,7 @@ It automates plausibility checks and prevalence analyses and respective summarie

#### A useful workflow for plausibility check using `mwana`
```{r}
#| label: worflow
#| label: workflow
#| echo: false
#| fig-align: center
Expand Down Expand Up @@ -120,13 +123,16 @@ Please note that `mwana` is still highly experimental and is undergoing a lot of

## Installation

`mwana` is not yet on CRAN but you can install the development version from [nutriverse R universe](https://nutriverse.r-universe.dev) as follows:
`mwana` is not yet on CRAN but can be installed fromthe [nutriverse R Universe](https://nutriverse.r-universe.dev) as follows:

```{r}
#| lable: installation
#| label: installation
#| eval: false
remotes::install_github("tomaszaba/ipccheckr")
install.packages(
"mwana",
repos = c('https://nutriverse.r-universe.dev', 'https://cloud.r-project.org')
)
```

Then load to in memory with
Expand Down
8 changes: 3 additions & 5 deletions inst/WORDLIST
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ MUAC
Maravia
Metuge
ORCID
Oftentimes
Orçamento
WFHZ
WIP
anthro
ao
callout
centimeters
Expand All @@ -37,15 +37,13 @@ mfaz
millimeters
muac
mwana
mwana’s
nipnTK
nutriverse
offs
requeriments
ssite
tibble
undernutrition
unweigthed
wfhz
whz
wtfactor
zscorer
’s

0 comments on commit f2ff6d1

Please sign in to comment.