This repository has been archived by the owner on May 10, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy pathREADME.Rmd
105 lines (67 loc) · 3.58 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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
mchtoolbox: Maternal Child Health Toolbox <img src="man/figures/imgHexSmall.png" align="right" />
==========
[](https://travis-ci.com/ropenscilabs/mchtoolbox)
[](https://codecov.io/gh/ropenscilabs/mchtoolbox)
Use `mchtoolbox` to calculate percentiles and z-scores for a child’s sex and age for BMI, weight, height, and head circumference based on CDC growth charts.
### Motivation
Reference data from nationally representative populations is used in maternal and child health research and public health surveillance to calculate percentiles, z-scores, and related values. This is important for measures that naturally change over the lifespan, such as body mass index and blood pressure. It can be difficult to calculate these variables and incorporate them into a [tidy](https://www.tidyverse.org/) workflow because published code is often not available in the R language (or in any language), or in the same place. The motivation for this project is it create
a package that contains functions compatible with the `tidyverse` to calculate commonly used measures in maternal child health. We are also working on a shiny app for EDA and so that users can easily load a CSV and calculate these measures in the app.
### Expected Input
`cdc_growth()` takes as input a data.frame with the following columns (**units**):
* sex: 1=male, 2=female
* agemos: months
* height: cm
* weight: kg
* headcir: cm (optional)
## Installation
Install `mchtoolbox` from Github:
```{r gh-installation, eval = FALSE}
# install.packages("devtools")
devtools::install_github("ropenscilabs/mchtoolbox")
```
## Example
This is a basic example which shows you how to solve a common problem:
```{r example, eval = FALSE}
## NHANES example data is included with package
create_cdc_growth(nhanes_data)
```
### Shiny App
### Code of Conduct
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
### Project Origin
This project was begun during the [2018 rOpenSci unconference](unconf18.ropensci.org):
https://github.com/ropensci/unconf18/issues/49
Contributors:
* [Monica W. Gerber](https://github.com/monicagerber)
* [Charles T. Gray](https://github.com/softloud)
* [Jennifer Thompson](https://jenthompson.me/)
* [W. Kyle Hamilton](http://kylehamilton.com/)
* [Jenny Draper](https://www.esr.cri.nz)
A special thank you to:
* [Maëlle Salmon](http://www.masalmon.eu/) for teaching us about `usethis`.
* [Jenny Bryan](https://twitter.com/JennyBryan) for github resuscitation.
### Future Directions
* Add all of the calculations in the original CDC SAS macro, including:
+ Flagging for biologically implausible values
+ headcir- and length/height-for-age calculations
+ value-for-length calculations
+ obesity measures (%bmip95)
* Add functions for:
+ weight-for-gestational age (child)
+ gestational weight gain z score (maternal)
+ blood pressure percentiles (child)
### Original Github Issue
[Link](https://github.com/ropensci/unconf18/issues/49) to original issue from unconf18.