drop enercast submodule; drop Rcpp requirement; fix doc, complete code, fix fix fix

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

diff --git a/epclust/man/epclust-package.Rd b/epclust/man/epclust-package.Rd
index c6bfac0..f991746 100644 (file)
--- a/epclust/man/epclust-package.Rd
+++ b/epclust/man/epclust-package.Rd
@@ -12,11 +12,25 @@
 }
 
 \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).
+  Non-R-base dependencies:
+  \itemize{
+    \item cluster: for PAM algorithm
+    \item bigmemory: to share (big) matrices between processes
+    \item wavelets: to compute curves contributions using DWT
+    \item Rwave: to compute the CWT
+  }
+
+  Suggested packages:
+  \itemize{
+    \item synchronicity: to compute synchrones in // (concurrent writes)
+    \item devtools,testthat,roxygen2: development environment (doc, reload, test...)
+    \item MASS: generate multivariate gaussian samples in tests
+    \item wmtsa: generate sample curves for \code{claws} examples
+    \item DBI: for the example with series in an SQLite DB
+    \item digest: to compare \code{claws} examples results
+  }
+
+  The package vignette was generated with Jupyter, outside R packaging flow.
 }
 
 \author{
@@ -24,11 +38,3 @@
 
        Maintainer: \packageMaintainer{epclust}
 }
-
-%\references{
-%      TODO: Literature or other references for background information
-%}
-
-%\examples{
-%      TODO: simple examples of the most important functions
-%}