R/TreeDistData-package.R

#' 'TreeDistData' is an R package that contains the functions and scripts used to
#' compare the performance of tree distance metrics in Smith (2020).
#'
#' The "[Articles](https://ms609.github.io/TreeDistData/articles/)" link in the
#' navigation bar lists vignettes detailing the output of analyses corresponding
#' to the stated sections of Smith (2020).  Each of these pages includes a
#' link to the R source code, which can be used to reproduce the analytical
#' results.
#'
#' The "[Reference](https://ms609.github.io/TreeDistData/reference/)" link lists
#' convenience functions, which facilitate calls to "TreeDist", and data objects
#' that store the results of lengthy analyses.  The code used to generate
#' these data objects is available in the
#' [`data-raw`](https://github.com/ms609/TreeDistData/tree/master/data-raw)
#' directory.
#'
#'
#' ## References
#'
#' Smith, M.R. (2020). [Information theoretic Generalized Robinson-Foulds
#' metrics for comparing phylogenetic
#' trees](https://dx.doi.org/10.1093/bioinformatics/btaa614). _Bioinformatics_
#' 36: 5007–5013.
#' @keywords internal
"_PACKAGE"

# The following block is used by usethis to automatically manage
# roxygen namespace tags. Modify with care!
## usethis namespace: start
## usethis namespace: end
NULL
ms609/TreeDistData documentation built on May 21, 2021, 6:53 a.m.