[PHYLO] adding groups.

src/Gargantext/Types/Phylo.hs

@@ -19,10 +19,11 @@ Phylomemy was first described in [REF].
 -}
 
 {-# LANGUAGE DeriveGeneric        #-}
+{-# LANGUAGE TemplateHaskell      #-}
 
 module Gargantext.Types.Phylo where
 
-import Data.Aeson   (ToJSON, FromJSON)
+import Data.Aeson.TH (deriveJSON)
 import Data.Maybe   (Maybe)
 import Data.Text    (Text)
 import Data.Time    (UTCTime)
@@ -30,10 +31,11 @@ import Data.Time    (UTCTime)
 import GHC.Generics (Generic)
 
 import Gargantext.Prelude
+import Gargantext.Utils.Prefix (unPrefix)
 
 ------------------------------------------------------------------------
--- | Phylo datatype descriptor
--- Period: time Segment of the whole phylomemy in UTCTime format (start,end)
+-- | Phylo datatype descriptor of a phylomemy
+-- Period : time Segment of the whole phylomemy in UTCTime format (start,end)
 -- Ngrams : list of all (possible) terms contained in the phylomemy (with their id)
 -- Steps  : list of all steps to build the phylomemy
 data Phylo = Phylo { _phyloPeriod :: (Start, End)
@@ -47,39 +49,41 @@ type End     = UTCTime
 type Ngram   = (NgramId, Text)
 type NgramId = Int
 
--- | PhyloStep datatype descriptor
+-- | PhyloStep : steps of phylomemy on temporal axis
 -- Period: tuple (start date, end date) of the step of the phylomemy
 -- Levels: levels of granularity
 data PhyloStep = PhyloStep { _phyloStepPeriod :: (Start, End)
-                           , _phyloStepLevels :: [Level]
+                           , _phyloStepLevels :: [PhyloLevel]
                            } deriving (Generic)
 
--- | Level of a step of a Phylomemy descriptor
--- Label: maybe has a label as text
--- Ngrams: set of terms that build the group
--- Temporal Parents: directed and weighted link to Parents
+-- | PhyloLevel : levels of phylomemy on level axis
 -- Levels description:
 -- Level 0: Ngram equals itself  (by identity) == _phyloNgrams
--- Level 1: Semantic grouping        (by stems + by qualitative expert meaning)
--- Level 2: Frequent Item Set groups (by statistics)
--- Level 3: Clustering               (by statistics)
-data Level = Level { _levelLabel              :: Maybe Text
-                   , _levelNgrams             :: [NgramId]
+-- Level 1: Group gathers synonyms (by stems + by qualitative expert meaning)
+-- Level 2: Group is Frequent Item Set          (by statistics)
+-- Level 3: Group is a cluster or community  (by statistics)
 
-                   , _levelTemporalParents    :: [NgramId]
-                   , _levelTemporalChilds     :: [NgramId]
+type PhyloLevel = [PhyloGroup]
 
-                   , _levelGranularityParents :: [NgramId]
-                   , _levelGranularityChilds  :: [NgramId]
-              } deriving (Generic)
+-- | PhyloGroup : group of ngrams at each level and step
+-- Label: maybe has a label as text
+-- Ngrams: set of terms that build the group
+-- Temporal Parents|Childs: directed and weighted link to Parents|Childs (Temporal axis)
+-- Granularity Parents|Childs: directed and weighted link to Parents|Childs (Granularity axis)
+data PhyloGroup = PhyloGroup { _phyloGroupLabel              :: Maybe Text
+                             , _phyloGroupNgrams             :: [NgramId]
                    
--- | JSON instances
-instance FromJSON Phylo
-instance ToJSON   Phylo
+                             , _phyloGroupTemporalParents    :: [Edge]
+                             , _phyloGroupTemporalChilds     :: [Edge]
                    
-instance FromJSON PhyloStep
-instance ToJSON   PhyloStep
+                             , _phyloGroupGranularityParents :: [Edge]
+                             , _phyloGroupGranularityChilds  :: [Edge]
+                             } deriving (Generic)
 
-instance FromJSON Level
-instance ToJSON   Level
+type Edge   = (NgramId, Weight)
+type Weight = Double
 
+-- | JSON instances
+$(deriveJSON (unPrefix "_phylo") ''Phylo)
+$(deriveJSON (unPrefix "_phyloStep")  ''PhyloStep)
+$(deriveJSON (unPrefix "_phyloGroup") ''PhyloGroup)