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%"
)
options(width = 80)
```
# growthscreener

<!-- badges: start -->
[![R-CMD-check](https://github.com/growthcharts/growthscreener/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/growthcharts/growthscreener/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

The `growthscreener` package implements tools to evaluate child 
growth with respect to Dutch criteria for unusual growth. 
Application of these tools helps to identify children that meet 
criteria for criteria for referral from youth health care (JGZ) for
follow-up with a general physician or paediatrician.

The current version implements Dutch guidelines for

- height
- weight
- head circumference
- language development

## Installation

The following statements will install the `growthscreener` package

```{r eval = FALSE}
install.packages("remotes")
remotes::install_github("growthcharts/growthscreener")
```

## Example

Find the advice for a very short girl:

```{r example}
library(growthscreener)

# a very short girl, 4 months old
msgcode <- calculate_advice_hgt(sex = "female", bw = 3250, ga = 40, dom = 0.367, y = 55)
msgcode
cat(fold(msg(msgcode)))
```

The height SDS at the age of about 4 months is equal to -3.255, which is 
the reason for referral.

## Background

The package implements the following guidelines:

- **JGZ-Richtlijn Lengtegroei 2019**: <https://www.ncj.nl/richtlijnen/alle-richtlijnen/richtlijn/lengtegroei-2019>
- **JGZ-Richtlijn Overgewicht 2012**: <https://www.ncj.nl/richtlijnen/alle-richtlijnen/richtlijn/overgewicht>
- **JGZ-Richtlijn Ondergewicht 2019**: <https://www.ncj.nl/richtlijnen/alle-richtlijnen/richtlijn/ondergewicht-2019>
- **Beslisboom Hoofdomtrek**: A decision tree for head circumference for children below the age of 1 year.
- **JGZ-Richtlijn Taalontwikkeling 2018**: <https://www.ncj.nl/richtlijnen/alle-richtlijnen/richtlijn/taalontwikkeling>

There are `r nrow(messages)` signals. To see them all:

```{r eval=FALSE}
messages
```