hei

hei: Calculate Healthy Eating Index (HEI) Scores - Published in JOSS (2017)

https://github.com/timfolsom/hei

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 5 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    2 of 3 committers (66.7%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software
Last synced: 6 months ago · JSON representation

Repository

R Package for Calculating Healthy Eating Index (HEI) Scores

Basic Info
  • Host: GitHub
  • Owner: timfolsom
  • License: gpl-3.0
  • Language: R
  • Default Branch: master
  • Homepage:
  • Size: 11.2 MB
Statistics
  • Stars: 7
  • Watchers: 2
  • Forks: 5
  • Open Issues: 2
  • Releases: 0
Created over 9 years ago · Last pushed over 7 years ago
Metadata Files
Readme Changelog License

README.md

HEI

Travis-CI Build Status CRAN_Status_Badge codecov CRAN Downloads JOSS Publication


Overview


The goal of hei is to calculate Healthy Eating Index (HEI) scores from National Health and Nutrition Examination Survey (NHANES) data for use in dietary analyses. The HEI is a dietary metric designed by the USDA and NCI to gauge adherence to the US Dietary Guidelines.

Installation


hei is available on CRAN, and can be installed as follows:

install.packages("hei")

To install the development version hosted on this repository, use the devtools package and the following:

```

install.packages("devtools")

devtools::install_github("timfolsom/hei") ```

Getting Started


library(hei)

The hei package contains one key function:

hei() takes as its arguments three data sets: an FPED data set, a NHANES dietary data set, and an NHANES demographic data set, returning a HEI score for each individual in the NHANES study being analyzed.

hei also includes get_fped() get_diet() and get_demo() for retrieving data from the Food Patterns Equivalents Database (FPED) and the NHANES dietary and demographic databases, respectively. The FPED data sets (in the public domain) retrieved by get_fped() are built into the package and have been converted to .csv files from the SAS data format in which they were originally published by their creators. get_diet() and get_demo() require the R package nhanesA which is employed to retrieve NHANES data sets directly from the web.

Related Work


hei is intended as a tool to aid in the analysis of NHANES data. It is important to be familiar with NHANES and its complex survey design as well as the FPED, which is derived from NHANES, before beginning any analyses involving the HEI.

Contributing

hei is licensed under the GNU General Public License Version 3. Questions, feature requests and bug reports are welcome via the issue queue. The maintainer will review pull requests and incorporate contributions at his discretion.

JOSS Publication

hei: Calculate Healthy Eating Index (HEI) Scores
Published
October 04, 2017
Volume 2, Issue 18, Page 417
Authors
Tim Folsom ORCID
University of Virginia
Vp Nagraj ORCID
University of Virginia
Editor
Thomas J. Leeper ORCID

GitHub Events

Total
Last Year

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 82
  • Total Committers: 3
  • Avg Commits per committer: 27.333
  • Development Distribution Score (DDS): 0.159
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
VP Nagraj v****j@v****u 69
Tim Folsom t****f@v****u 12
Arfon Smith a****n 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 19
  • Total pull requests: 7
  • Average time to close issues: 15 days
  • Average time to close pull requests: 37 minutes
  • Total issue authors: 5
  • Total pull request authors: 2
  • Average comments per issue: 1.26
  • Average comments per pull request: 0.29
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • maelle (14)
  • vpnagraj (2)
  • bmittman (1)
  • chiragjp (1)
  • mcarabel (1)
Pull Request Authors
  • timfolsom (6)
  • arfon (1)
Top Labels
Issue Labels
enhancement (2)
Pull Request Labels

Dependencies

DESCRIPTION cran
  • R >= 2.10 depends
  • nhanesA * imports
  • dplyr * suggests
  • ggplot2 * suggests
  • knitr * suggests
  • rmarkdown * suggests
  • testthat * suggests