Package hei. August 17, 2017

Transcription

1 Type Package Title Calculate Healthy Eating Index (HEI) Scores Date Version Package hei August 17, 2017 Maintainer Tim Folsom Calculates Healthy Eating Index (HEI) scores for National Health and Nutrition Examination Survey (NHANES) data sets to facilitate analysis of demographic and dietary differences. For more information on the HEI metric, refer to Guenther et al. (2014) <doi: /jn >. License GPL-3 Encoding UTF-8 LazyData true Depends R (>= 2.10) Imports nhanesa RoxygenNote Suggests knitr, rmarkdown, testthat, dplyr, ggplot2 VignetteBuilder knitr NeedsCompilation no Author VP Nagraj [aut], Tim Folsom [aut, cre] Repository CRAN Date/Publication :34:24 UTC R topics documented: combo get_demo get_diet get_fped hei leg_all

2 2 combo Index 9 combo Data set combination and manipulation for use in HEI scoring. combo returns a single data set combining the FPED and NHANES dietary and demographic data sets. Additionally, it allows for specification of an age threshold such that records with age values below this number will be excluded from the output. Furthermore, any rows for which dietary recall was deemed unreliable (DRSTZ!= 1) are automatically dropped. Finally, additional necessary HEI inputs are generated from the existing columns, see "" section below. combo(fped, diet, demograph, agethresh = 2) fped diet demograph agethresh food pattern equivalent database data dietary data from NHANES database demographic data from NHANES database numeric threshold for age of survey participants to be included Object of class data.frame representing a data set fully prepped for HEI score calculation. All columns from the three input data sets are preserved while a handful of additional derivative columns are included, specifically: WHOLEFRT: T_F_CITMLB (citrus, melons, and berries) + T_F_OTHER (fruits excluding citrus, melons, and berries) MONOPOLY: TMFAT (total monounsaturated fatty acids) + TPFAT (total polyunsaturated fatty acids) ALLMEAT: T_PF_MPS_TOTAL (meat, poultry, seafood, organ meat, and cured meat) + T_PF_EGGS (eggs and egg substitutes) + T_PF_NUTSDS (peanuts, tree nuts, and seeds) + T_PF_SOY (soy products) SEAPLANT: T_PF_SEAFD_HI (Seafood high in n-3 fatty acids) + T_PF_SEAFD_LOW (Seafood low in n-3 fatty acids) + T_PF_NUTSDS (peanuts, tree nuts, and seeds) + T_PF_SOY + (soy products) ADDSUGC: T_ADD_SUGARS (added sugars) * 16 SOLFATC: T_SOLID_FATS (fats naturally present in meat, etc.) * 9 MAXALCGR: TKCAL (total calories) / 1000 * 13 EXALCCAL (amount of alcohol above acceptable threshold): (TALCO (total alcohol) - MAX- ALCGR) * 7 EMPTYCAL10: ADDSUGC + SOLFATC + EXALCCAL

3 get_demo 3 get_demo NHANES demographic data retrieval. get_demo returns an abridged National Health and Nutrition Examination Survey (NHANES) demographic data set for a given year. get_demo(year) year year combination of data set to retrieve... must be one of the following: "2005/2006" "2007/2008" "2009/2010" "2011/2012" "2013/2014" Object of class data.frame containing a modified NHANES demographic data set for a specified year. The complete NHANES demographic data set contains several more variables than are necessary for computing HEI scores. In fact, the only variable contained in the returned data set (in addition to an NHANES unique sequence identifier for each participant) is not, strictly speaking, even required itself, but becomes relevant if data sets from multiple separate NHANES iterations are concatenated, specifically: SDDSRVYR: This variable represents the two-year data release cycle number (e.g. a value of 6 denotes NHANES ). References Examples ## Not run: get_demo("2009/2010") ## End(Not run)

4 4 get_diet get_diet NHANES dietary data retrieval. get_diet returns an abridged National Health and Nutrition Examination Survey (NHANES) dietary data set for a given year. get_diet(year, day) year day year combination of data set to retrieve... must be one of the following: "2005/2006" "2007/2008" "2009/2010" "2011/2012" "2013/2014" identifier for survey day to retrieve... must be one of the following: "first" (data for study participants from first day) "second" (study participant data from second day) "both" (data for study participants present in both days, with values averaged across the two days) Object of class data.frame containing a modified NHANES dietary data set for a specified year and day. The complete NHANES dietary data set contains several more variables than are necessary for computing HEI scores. The data set returned by this function has been trimmed down to contain (in addition to an NHANES unique sequence identifier for each participant) only the columns of data needed for HEI score calculation, specifically: References TKCAL: Energy (kcal) TSFAT: Total saturated fatty acids (gm) TMFAT: Total monounsaturated fatty acids (gm) TPFAT: Total polyunsaturated fatty acids (gm) TSODI: Sodium (mg) TALCO: Alcohol (gm)

5 get_fped 5 Examples ## Not run: get_diet("2009/2010", "both") get_diet("2009/2010", "first") ## End(Not run) get_fped FPED data retrieval. get_fped returns an abridged Food Patterns Equivalents Database (FPED) data set for a given year. get_fped(year, day) year day year combination of data set to retrieve... must be one of the following: "2005/2006" "2007/2008" "2009/2010" "2011/2012" "2013/2014" identifier for survey day to retrieve... must be one of the following: "first" (data for study participants from first day) "second" (study participant data from second day) "both" (data for study participants present in both days, with values averaged across the two days) Object of class data.frame containing a modified FPED data set for specified year and day. FPED proper contains several more variables than are necessary for computing HEI scores. The data set returned by this function has been trimmed down to contain (in addition to an NHANES unique sequence identifier for each participant, age, and dietary recall status) only the columns of data needed for HEI score calculation, specifically: T_F_CITMLB: Intact fruits (whole or cut) of citrus, melons, and berries (cup eq.) T_PF_EGGS: Eggs (chicken, duck, goose, quail) and egg substitutes (oz. eq.) T_F_OTHER: Intact fruits (whole or cut); excluding citrus, melons, and berries (cup eq.) T_PF_MPS_TOTAL: Total of meat, poultry, seafood, organ meat, and cured meat (oz. eq.)

6 6 get_fped T_PF_SOY: Soy products, excluding calcium fortified soy milk (soymilk) and mature soybeans (oz. eq.) T_PF_SEAFD_HI: Seafood (finfish, shellfish, and other seafood) high in n-3 fatty acids (oz. eq.) T_PF_SEAFD_LOW: Seafood (finfish, shellfish, and other seafood) low in n-3 fatty acids (oz. eq.) T_PF_NUTSDS: Peanuts, tree nuts, and seeds; excludes coconut (oz. eq.) T_SOLID_FATS: Fats naturally present in meat, poultry, eggs, and dairy (lard, tallow, and butter); hydrogenated or partially hydrogenated oils; shortening; palm, palm kernel and coconut oils; fat naturally present in coconut meat and cocoa butter; and 50% of fat present in stick and tub margarines and margarine spreads (grams) T_ADD_SUGARS: Foods defined as added sugars (tsp. eq.) T_V_TOTAL: Total dark green, red and orange, starchy, and other vegetables; excludes legumes (cup eq.) T_V_LEGUMES: Total dark green, red and orange, starchy, and other vegetables; excludes legumes (cup eq.) T_V_DRKGR: Dark green vegetables (cup eq.) T_F_TOTAL: Total intact fruits (whole or cut) and fruit juices (cup eq.) T_G_WHOLE: Grains defined as whole grains and contain the entire grain kernel - the bran, germ, and endosperm (oz. eq.) T_D_TOTAL: Total milk, yogurt, cheese, and whey. For some foods, the total dairy values could be higher than the sum of D_MILK, D_YOGURT, and D_CHEESE because miscellaneous dairy component composed of whey is not included in FPED as a separate variable. (cup eq.) T_G_REFINED: Refined grains that do not contain all of the components of the entire grain kernel (oz. eq.) References food-surveys-research-group/docs/fped-overview/ Examples get_fped("2009/2010", "both") get_fped("2005/2006", "first")

7 hei 7 hei Individual HEI scores calculation. hei calculates a Health Eating Index (HEI) score for individuals in the National Health and Nutrition Examination Survey (NHANES) studies based on input dietary, demographic and Food Pattern Equivalent Database (FPED) data. hei(fped, diet, demograph, agethresh = 2, verbose = FALSE) fped diet demograph agethresh verbose Food Pattern Equivalent Database data; see get_fped dietary data from NHANES database; see get_diet demographic data from NHANES database; see get_demo numeric threshold for age in years of survey participants to be included; any individual less than the value specified will be excluded; defaults to 2 boolean indicating whether or not all columns from processed data should be output; default is FALSE designating only the following are included in the returned data.frame: SEQN: Respondent sequence number RIDAGEYR: Best age in years of the sample person at time of HH screening. Individuals 85 and over are topcoded at 85 years of age HEI: Overall Health Eating Index score for the given participant Object of class data.frame; defaults to only include columns for respondent identifier, age, and overall HEI score of each individual; this can be overidden with the verbose parameter to output all columns of the input data sets as well as 33 columns of calculated data related to HEI scoring and, significantly, a 70th column containing the total HEI score for each participant. References Examples ## Not run: fped0910 <- get_fped("2009/2010", "both") diet0910 <- get_diet("2009/2010", "both") demo0910 <- get_demo("2009/2010") hei(fped0910,diet0910,demo0910)

8 8 leg_all fped0506 <- get_fped("2005/2006", "first") diet0506 <- get_diet("2005/2006", "first") demo0506 <- get_demo("2005/2006") hei(fped0506,diet0506,demo0506, agethresh = 18) ## End(Not run) leg_all allocate legumes for HEI scoring allocate legumes for HEI scoring leg_all(dat) dat data to be processed data frame of dietary values with legumes allocated appropriately

9 Index combo, 2 get_demo, 3, 7 get_diet, 4, 7 get_fped, 5, 7 hei, 7 leg_all, 8 9