R/shmootl.R

In gact/shmootl: QTL Analysis Utilities for Yeast

# Start of shmootl.R ###########################################################

# TODO: unit testing.
# TODO: code examples.
# TODO: optimise code.

# shmootl ----------------------------------------------------------------------
#' QTL Analysis Utilities for Yeast
#' 
#' The \pkg{shmootl} package contains pipelines and functions for QTL analysis
#' in yeast. This package follows many of the conventions on \pkg{R/qtl}, and
#' depends on that package for standard QTL analysis. It also depends on
#' \pkg{R/funqtl} for QTL analysis with time-series phenotypes. See
#' below for links to these packages, as well as key references.
#' 
#' @template section-item-ids
#' @template section-syntactic-names
#' @template section-pipelines
#' 
#' @section See Also: 
#' 
#' \itemize{
#'   \item{\href{https://github.com/gact/shmootl}{shmootl on GitHub}}
#'   \item{\href{https://github.com/ikwak2/funqtl}{R/funqtl on GitHub}}
#'   \item{\href{http://www.rqtl.org/}{R/qtl}}
#' }
#' 
#' @template ref-arends-2010
#' @template ref-broman-2003
#' @template ref-kwak-2014
#'    
#' @aliases shmootl
#' @docType package
#' @name shmootl-package
NULL

# End of shmootl.R #############################################################