major folder reorganisation, R pkg is now epclust/ at first level. Experimental usage...

[epclust.git] / epclust / man / epclust-package.Rd

diff --git a/epclust/man/epclust-package.Rd b/epclust/man/epclust-package.Rd
new file mode 100644 (file)
index 0000000..c6bfac0
--- /dev/null
+++ b/epclust/man/epclust-package.Rd
@@ -0,0 +1,34 @@
+\name{epclust-package}
+\alias{epclust-package}
+\alias{epclust}
+\docType{package}
+
+\title{
+       \packageTitle{epclust}
+}
+
+\description{
+       \packageDescription{epclust}
+}
+
+\details{
+       The package devtools should be useful in development stage, since we rely on testthat for
+       unit tests, and roxygen2 for documentation. knitr is used to generate the package vignette.
+       Concerning the other suggested packages, 'parallel' can speed up (...TODO...)
+
+       The main function is located in R/main.R: it runs the clustering task (TODO: explain more).
+}
+
+\author{
+       \packageAuthor{epclust}
+
+       Maintainer: \packageMaintainer{epclust}
+}
+
+%\references{
+%      TODO: Literature or other references for background information
+%}
+
+%\examples{
+%      TODO: simple examples of the most important functions
+%}