From: Benjamin Auder <benjamin.a@mailoo.org>
Date: Thu, 5 Feb 2015 22:42:00 +0000 (+0100)
Subject: add README.html
X-Git-Url: https://git.auder.net/js/pieces/scripts/current/doc/screen_players.png?a=commitdiff_plain;h=195af7f900ef4a29ea6e1629a9e4934539e1c9b1;p=synclust.git

add README.html
---

diff --git a/README b/README
deleted file mode 100755
index 4a85bac..0000000
--- a/README
+++ /dev/null
@@ -1,16 +0,0 @@
-Author : Benjamin Auder, Christophe Giraud
-Institution : Université Paris Sud (Orsay) / CNRS
-
-This package allow to find regions of synchronous variation for a given population species. 
-Two methods are available, either direct graph clustering or parameters estimations in a convex optimization problem.
-
--------------------------------------------
-
-Main function to cluster populations data = findSyncVarRegions()
-
-To regenerate documentation, use R package roxygen2
-
-==================
-
-Acknowledgements :
-TODO
diff --git a/README.html b/README.html
new file mode 100755
index 0000000..8b45885
--- /dev/null
+++ b/README.html
@@ -0,0 +1,20 @@
+<h1>Clustering into regions of synchronous variations</h1>
+
+<p>Joint work with <a href="http://www.cmap.polytechnique.fr/~giraud/">Christophe Giraud</a>.</p>
+
+<hr/>
+
+<p>This R package implements a clustering method described in detail in <a href="http://www.cmap.polytechnique.fr/~giraud/SynchronousPop.pdf">this article</a>.</p>
+
+<p>The goal is to divide a map of observational sites into regions of similar intra-variability over the years, but 
+with distinct dynamics compared to other regions.
+The problem has both spatial (the sites) and temporal (measurements every year) aspects, and is difficult because 
+there are no a priori indications about the regions.</p>
+
+<hr/>
+
+<p>Two (heuristic) methods are available in the package, either direct graph clustering or parameters estimation 
+in a model-based formulation of the problem.</p>
+
+<p>
+Main function to cluster populations data: <code>findSyncVarRegions()</code>.</p>