[PHYLO] step -> period.

src/Gargantext/Types/Phylo.hs

@@ -35,12 +35,12 @@ import Gargantext.Utils.Prefix (unPrefix)
 
 ------------------------------------------------------------------------
 -- | 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)
-                   , _phyloNgrams :: [Ngram]
-                   , _phyloSteps  :: [PhyloStep]
+-- Duration : 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 { _phyloDuration :: (Start, End)
+                   , _phyloNgrams   :: [Ngram]
+                   , _phyloPeriods    :: [PhyloPeriod]
                    } deriving (Generic)
 
 type Start   = UTCTime
@@ -52,38 +52,37 @@ type NgramId = Int
 -- | 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 :: [PhyloLevel]
-                           } deriving (Generic)
+data PhyloPeriod = PhyloPeriod { _phyloPeriodDuration :: (Start, End)
+                               , _phyloPeriodLevels :: [PhyloLevel]
+                               } deriving (Generic)
 
 -- | PhyloLevel : levels of phylomemy on level axis
 -- Levels description:
--- Level 0: Ngram equals itself              (by identity) == _phyloNgrams
--- 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)
-
+-- Level -1: Ngram equals itself         (by identity) == _phyloNgrams
+-- Level  0: Group of synonyms           (by stems + by qualitative expert meaning)
+-- Level  1: First level of clustering
+-- Level  N: Nth   level of clustering
 type PhyloLevel = [PhyloGroup]
 
 -- | PhyloGroup : group of ngrams at each level and step
--- Label: maybe has a label as text
+-- 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)
+-- 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]
+data PhyloGroup = PhyloGroup { _phyloGroupLabel         :: Maybe Text
+                             , _phyloGroupNgrams        :: [NgramId]
                    
-                             , _phyloGroupTemporalParents    :: [Edge]
-                             , _phyloGroupTemporalChilds     :: [Edge]
+                             , _phyloGroupPeriodParents :: [Edge]
+                             , _phyloGroupPeriodChilds  :: [Edge]
                    
-                             , _phyloGroupGranularityParents :: [Edge]
-                             , _phyloGroupGranularityChilds  :: [Edge]
+                             , _phyloGroupLevelParents  :: [Edge]
+                             , _phyloGroupLevelChilds   :: [Edge]
                              } deriving (Generic)
 
 type Edge   = (NgramId, Weight)
 type Weight = Double
 
 -- | JSON instances
-$(deriveJSON (unPrefix "_phylo") ''Phylo)
-$(deriveJSON (unPrefix "_phyloStep")  ''PhyloStep)
-$(deriveJSON (unPrefix "_phyloGroup") ''PhyloGroup)
+$(deriveJSON (unPrefix "_phylo"       ) ''Phylo       )
+$(deriveJSON (unPrefix "_phyloPeriod" ) ''PhyloPeriod )
+$(deriveJSON (unPrefix "_phyloGroup"  ) ''PhyloGroup  )