epclust/man/epclust-package.Rd

   1 \name{epclust-package}
   2 \alias{epclust-package}
   3 \alias{epclust}
   4 \docType{package}
   5
   6 \title{
   7     \packageTitle{epclust}
   8 }
   9
  10 \description{
  11     \packageDescription{epclust}
  12 }
  13
  14 \details{
  15     The package devtools should be useful in development stage, since we rely on testthat for
  16     unit tests, and roxygen2 for documentation. knitr is used to generate the package vignette.
  17     Concerning the other suggested packages, 'parallel' can speed up (...TODO...)
  18
  19     The main function is located in R/main.R: it runs the clustering task (TODO: explain more).
  20 }
  21
  22 \author{
  23     \packageAuthor{epclust}
  24
  25     Maintainer: \packageMaintainer{epclust}
  26 }
  27
  28 %\references{
  29 %   TODO: Literature or other references for background information
  30 %}
  31
  32 %\examples{
  33 %   TODO: simple examples of the most important functions
  34 %}