R/epiinfo.reader.R

In connectedblue/ProjectTemplate2: Provides custom template and other extensions of ProjectTemplate

#' Read an Epi Info file with a .rec file extension.
#'
#' This function will load all of the data sets stored in the specified
#' Epi Info file into the global environment.
#'
#' @param data.file The name of the data file to be read.
#' @param filename The path to the data set to be loaded.
#' @param variable.name The name to be assigned to in the global environment.
#'
#' @return No value is returned; this function is called for its side effects.
#'
#' @examples
#' library('ProjectTemplate2')
#'
#' \dontrun{epiinfo.reader('example.rec', 'data/example.rec', 'example')}
epiinfo.reader <- function(data.file, filename, variable.name)
{
  .require.package('foreign')

  assign(variable.name,
         foreign::read.epiinfo(filename),
         envir = .TargetEnv)
}