Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
cjendres1 committed Aug 3, 2016
1 parent 65dac31 commit 4026028
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 10 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: nhanesA
Version: 0.6.4.2
Date: 2016-07-17
Date: 2016-07-29
Title: NHANES Data Retrieval
Author: Christopher Endres
Maintainer: Christopher Endres <cjendres1@gmail.com>
Expand Down
2 changes: 1 addition & 1 deletion R/nhanes.R
Original file line number Diff line number Diff line change
Expand Up @@ -813,7 +813,7 @@ nhanesTranslate <- function(nh_table, colnames=NULL, data = NULL, nchar = 32,
#'
#' @importFrom stringr str_c str_to_title str_split str_sub str_extract_all
#' @importFrom utils browseURL
#' @param year The year in yyyy format where 1999 <= yyyy <= 2014.
#' @param year The year in yyyy format where 1999 <= yyyy <= 2016.
#' @param data_group The type of survey (DEMOGRAPHICS, DIETARY, EXAMINATION, LABORATORY, QUESTIONNAIRE).
#' Abbreviated terms may also be used: (DEMO, DIET, EXAM, LAB, Q).
#' @param nh_table The name of an NHANES table.
Expand Down
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# nhanesA
R package for browsing and retrieving NHANES data.

The goal of nhanesA is to allow fully customizable selection and import of NHANES data, as well as retrieval of information pertaining to NHANES data.
With nhanesA, most NHANES tables that are in SAS 'XPT' format can be readily imported as a data frame object.
NHANES tables are imported directly from the NHANES website so it is essential to have an active network connection.
No data is stored internally to nhanesA.
R package for browsing and retrieving data from the National Health And Nutrition Examination Survey (NHANES).
This package is designed to be useful for research and instructional purposes.

The functions in the nhanesA package allow for fully customizable selection and import of data directly from the [NHANES website](http://www.cdc.gov/nchs/nhanes/) thus it is essential to have an active network connection.

Install from CRAN: install.packages("nhanesA")

Install from the dev repo: install_github("cjendres1/nhanes")

[Manual](https://cran.r-project.org/web/packages/nhanesA/nhanesA.pdf)

[Vignette: Introducing nhanesA](https://cran.r-project.org/web/packages/nhanesA/vignettes/Introducing_nhanesA.html)

Several functions are provided to browse the NHANES database, including browseNHANES() which opens a browser to the NHANES website.
There are also functions that make use of rvest web scraping utilities to list available NHANES tables, their attributes, constituent variables, and code translations.
2 changes: 1 addition & 1 deletion man/browseNHANES.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 4026028

Please sign in to comment.