R/BTDR-package.R

In heckendorfc/BTDR: 'BUPID' Top-Down Result Conversion, Analysis, and Visualization

#' Functions to access BUPID Top-Down results
#' 
#' This package provides convenient functions to work with results files
#' generated with BUPID Top-Down. These include conversions to other formats
#' and common visualizations.
#' 
#' \tabular{ll}{
#'    Package: \tab BTDR\cr
#'    Type: \tab Package\cr
#'    Version: \tab 1.0\cr
#'    Date: \tab 2014-08-18\cr
#'    License: \tab BSD 2-clause License\cr
#' }
#' 
#' @aliases BTDR-package BTDR
#' 
#' @import methods
#' @import ggplot2
#' @importFrom xml2 xml_add_child xml_dtd xml_new_root write_xml
#' @importFrom magrittr %>%
#' @importFrom yaml yaml.load
#' @importFrom stats lm
#' 
#' @useDynLib BTDR
#'
#' @docType package
#' @author Christian Heckendorf
#' 
#' Maintainer: Christian Heckendorf <heckend@@bu.edu>
#' @references ~~ Literature or other references for background information ~~
#' @keywords package
#' 
#' @name BTDR-package
NULL