R/StataDCTutils-package.R

In mrdwab/StataDCTutils: Converts Stata dictionary files to formats more meaningful for R users

#'Example dataset to be converted to a csv file
#'
#'This is a sample dataset useful to demonstrate conversion to csv using
#'\code{\link{csvkit.fwf2csv}} after parsing the dictionary file (using
#'\code{\link{dct.parser}}) and creating a csvkit schema file (using
#'\code{\link{csvkit.schema}}).
#'
#'
#'@name data66_dat
#'@docType data
#'@source Obtained from
#'\url{http://faculty-staff.ou.edu/L/Carlos.E.Lamarche-1/ec5243/data.html}
#'@keywords datasets
NULL





#'Example dictionary file accompanying \code{\link{data66_dat}}
#'
#'Example dictionary file accompanying \code{\link{data66_dat}} to be parsed
#'using \code{\link{dct.parser}} and then possibly using other tools from the
#'\code{StataDCTutils} package.
#'
#'
#'@name data66_dct
#'@docType data
#'@source Obtained from
#'\url{http://faculty-staff.ou.edu/L/Carlos.E.Lamarche-1/ec5243/data.html}
#'@keywords datasets
NULL





#'Survey of Income and Program Participation (SIPP) - 1984 Panel
#'
#'Dictionary file for the full 1984 panel for NBER's Survey of Income and
#'Program Participation (SIPP).
#'
#'
#'@name sipp84fp_dct
#'@docType data
#'@source \url{http://thedataweb.rm.census.gov/ftp/sipp_ftp.html#sipp84}
#'@keywords datasets
NULL





#'Parses Stata dictionary files for further use with R
#'
#'Utilities to make reading fixed-width-format datasets distributed as a
#'\code{.dat}/\code{.dct}/\code{.do} set of Stata files more convenient with R.
#'
#'\tabular{ll}{ Package: \tab StataDCTutils\cr Type: \tab Package\cr Version:
#'\tab 1.0\cr Date: \tab 2013-01-16\cr License: \tab CC-SA\cr }
#'
#'@name StataDCTutils-package
#'@aliases StataDCTutils-package StataDCTutils
#'@docType package
#'@author Ananda Mahto
#'
#'Maintainer: Ananda Mahto <mrdwab@@gmail.com>
#'@references Initial versions of this function can be found at
#'\url{http://stackoverflow.com/questions/14224321/reading-dat-and-dct-directly-from-r}
#'@keywords package
NULL