src/Gargantext/Viz/Phylo/Example.hs

   1 {-|
   2 Module      : Gargantext.Viz.Phylo.Example
   3 Description : Phylomemy example based on history of Cleopatre.
   4 Copyright   : (c) CNRS, 2017-Present
   5 License     : AGPL + CECILL v3
   6 Maintainer  : team@gargantext.org
   7 Stability   : experimental
   8 Portability : POSIX
   9
  10 -- | Cesar et Cleôpatre
  11 -- Exemple de phylomemie
  12 -- French without accents
  13
  14
  15 TODO:
  16 - split the functions : RAW -> Document -> Ngrams
  17
  18 -- reverse history: antechronologique
  19 -- metrics support
  20
  21
  22 -}
  23
  24 {-# LANGUAGE NoImplicitPrelude #-}
  25 {-# LANGUAGE FlexibleContexts  #-}
  26 {-# LANGUAGE OverloadedStrings #-}
  27 {-# LANGUAGE MultiParamTypeClasses #-}
  28
  29 module Gargantext.Viz.Phylo.Example where
  30
  31 import Control.Lens     hiding (makeLenses, both, Level)
  32
  33 import Data.Bool        (Bool, not)
  34 import Data.List        ((\\), notElem, concat, union, intersect, tails, tail, head, last, null, zip, sort, length, any, (++), (!!), nub, sortOn, reverse, splitAt, take, delete, init, groupBy)
  35 import Data.Map         (Map, elems, insert, member, adjust, singleton, empty, (!), keys, restrictKeys, mapWithKey, filterWithKey, mapKeys, intersectionWith, unionWith)
  36 import Data.Maybe       (mapMaybe,isJust,fromJust, isNothing)
  37 import Data.Semigroup   (Semigroup)
  38 import Data.Set         (Set)
  39 import Data.Text        (Text, unwords, toLower, words)
  40 import Data.Tuple       (fst, snd)
  41 import Data.Tuple.Extra
  42 import Data.Vector      (Vector, fromList, elemIndex, (!))
  43
  44 import Debug.Trace      (trace)
  45
  46 import Gargantext.Prelude          hiding (head)
  47 import Gargantext.Text.Terms.Mono  (monoTexts)
  48
  49 import Gargantext.Viz.Phylo
  50 import Gargantext.Viz.Phylo.Aggregates.Cluster
  51 import Gargantext.Viz.Phylo.Aggregates.Cooc
  52 import Gargantext.Viz.Phylo.Aggregates.Document
  53 import Gargantext.Viz.Phylo.Aggregates.Fis
  54 import Gargantext.Viz.Phylo.BranchMaker
  55 import Gargantext.Viz.Phylo.LevelMaker
  56 import Gargantext.Viz.Phylo.LinkMaker
  57 import Gargantext.Viz.Phylo.Metrics.Proximity
  58 import Gargantext.Viz.Phylo.Metrics.Clustering
  59 import Gargantext.Viz.Phylo.Tools
  60 import Gargantext.Viz.Phylo.View.Display
  61 import Gargantext.Viz.Phylo.View.Filters
  62 import Gargantext.Viz.Phylo.View.Metrics
  63 import Gargantext.Viz.Phylo.View.Sort
  64 import Gargantext.Viz.Phylo.View.Taggers
  65 import Gargantext.Viz.Phylo.View.ViewMaker
  66
  67
  68 import qualified Data.Bool   as Bool
  69 import qualified Data.List   as List
  70 import qualified Data.Map    as Map
  71 import qualified Data.Maybe  as Maybe
  72 import qualified Data.Set    as Set
  73 import qualified Data.Tuple  as Tuple
  74 import qualified Data.Vector as Vector
  75
  76
  77 ------------------------------------------------------------------------
  78 -- | STEP 13 | -- Create a Phylo from a Rest request
  79
  80
  81 phylo' :: Phylo
  82 phylo' = toPhylo phyloQuery corpus actants
  83
  84
  85 urlPhyloQuery :: [Char]
  86 urlPhyloQuery = "title=Cesar et Cleôpatre&description=An example of Phylomemy (french without accent)"
  87                 ++ "grain=5&step=3"
  88                 ++ "fstCluster=FrequentItemSet&fstClusterParam=supportInf:1&fstClusterParam=filterFis:True&fstClusterParam=emptyFis:False"
  89                 ++ "timeMatching=WeightedLogJaccard&timeMatchingParam=sensibility:0&timeMatchingThreshold:0.01"
  90                 ++ "levelMax=2"
  91                 ++ "cluster=RelatedComponents&clusterProximity=Filiation"
  92
  93
  94 phyloQuery :: PhyloQuery
  95 phyloQuery = PhyloQuery "Cesar et Cleôpatre" "An example of Phylomemy (french without accent)"
  96                         5 3
  97                         (QueryClustering FrequentItemSet
  98                                     (singleton "supportInf" 1)
  99                                     (Map.fromList [("filterFis",True),("emptyFis",False)])
 100                                     Nothing)
 101                         (QueryProximity  WeightedLogJaccard
 102                                     (singleton "sensibility" 0) (Just 0.01))
 103                         2
 104                         (QueryClustering RelatedComponents
 105                                     empty empty
 106                                     (Just (QueryProximity Filiation empty Nothing)))
 107
 108
 109 ------------------------------------------------------------------------
 110 -- | STEP 12 | -- Return a Phylo as a View for upcomming visiualization tasks
 111
 112
 113 -- | To do : add a queryParser from an URL and then update the defaultQuery
 114 urlToQuery :: Text -> PhyloQueryView
 115 urlToQuery url = defaultQuery
 116               & qv_metrics %~ (++ [BranchAge])
 117               & qv_filters %~ (++ [QueryFilter LonelyBranch (Map.fromList [("nbInf",2),("nbSup",2),("nbNs",1)]) empty])
 118               & qv_taggers %~ (++ [BranchLabelFreq,GroupLabelCooc])
 119
 120
 121 defaultQuery :: PhyloQueryView
 122 defaultQuery = PhyloQueryView 3 Descendant False 1 [] [] [] (Just (ByBranchAge,Asc)) Flat True
 123
 124
 125 urlQuery :: Text
 126 urlQuery = "level=3&childs=false&filter=LonelyBranchFilter(2,2,1):true&metric=BranchAge&tagger=BranchLabelFreq&tagger=GroupLabelCooc"
 127
 128
 129 toPhyloView :: Text -> Phylo -> PhyloView
 130 toPhyloView url p = queryToView (urlToQuery url) p
 131
 132
 133 phyloView :: PhyloView
 134 phyloView = toPhyloView urlQuery phylo6
 135
 136
 137 ------------------------------------------------------------------------
 138 -- | STEP 11 | -- Incrementaly cluster the PhyloGroups n times, link them through the Periods and build level n of the Phylo
 139
 140
 141 phylo6 :: Phylo
 142 phylo6 = toNthLevel 6 (QueryProximity WeightedLogJaccard (singleton "sensibility" 0) (Just 0.01)) (QueryClustering RelatedComponents empty empty (Just (QueryProximity Filiation empty Nothing)))  phylo3
 143
 144
 145 phylo3 :: Phylo
 146 phylo3 = setPhyloBranches 3
 147        $ interTempoMatching Descendant 3 (QueryProximity WeightedLogJaccard (singleton "sensibility" 0) (Just 0.01))
 148        $ interTempoMatching Ascendant 3 (QueryProximity WeightedLogJaccard (singleton "sensibility" 0) (Just 0.01))
 149        $ setLevelLinks (2,3)
 150        $ addPhyloLevel 3
 151           (phyloToClusters 2 (QueryProximity WeightedLogJaccard (singleton "sensibility" 0) (Just 0.01)) (QueryClustering RelatedComponents empty empty (Just (QueryProximity Filiation empty Nothing))) phyloBranch2)
 152           phyloBranch2
 153
 154
 155 ------------------------------------------------------------------------
 156 -- | STEP 10 | -- Cluster the Fis
 157
 158 phyloBranch2 :: Phylo
 159 phyloBranch2 = setPhyloBranches 2 phylo2_c
 160
 161
 162 phylo2_c :: Phylo
 163 phylo2_c = interTempoMatching Descendant 2 (QueryProximity WeightedLogJaccard (singleton "sensibility" 0) (Just 0.01)) phylo2_p
 164
 165
 166 phylo2_p :: Phylo
 167 phylo2_p = interTempoMatching Ascendant 2 (QueryProximity WeightedLogJaccard (singleton "sensibility" 0) (Just 0.01)) phylo2_1_2
 168
 169
 170 phylo2_1_2 :: Phylo
 171 phylo2_1_2 = setLevelLinks (1,2) phylo2
 172
 173
 174 -- | phylo2 allready contains the LevelChilds links from 2 to 1
 175 phylo2 :: Phylo
 176 phylo2 = addPhyloLevel 2 phyloCluster phyloBranch1
 177
 178
 179 phyloCluster :: Map (Date,Date) [Cluster]
 180 phyloCluster = phyloToClusters 1 (QueryProximity WeightedLogJaccard (singleton "sensibility" 0) (Just 0.01)) (QueryClustering RelatedComponents empty empty (Just (QueryProximity Filiation empty Nothing))) phyloBranch1
 181
 182
 183 ------------------------------------------------------------------------
 184 -- | STEP 9 | -- Find the Branches
 185
 186
 187 phyloBranch1 :: Phylo
 188 phyloBranch1 = setPhyloBranches 1 phylo1_c
 189
 190
 191 ------------------------------------------------------------------------
 192 -- | STEP 8 | -- Link the PhyloGroups of level 1 through the Periods
 193
 194
 195 phylo1_c :: Phylo
 196 phylo1_c = interTempoMatching Descendant 1 (QueryProximity WeightedLogJaccard (singleton "sensibility" 0) (Just 0.01)) phylo1_p
 197
 198
 199 phylo1_p :: Phylo
 200 phylo1_p = interTempoMatching Ascendant 1 (QueryProximity WeightedLogJaccard (singleton "sensibility" 0) (Just 0.01)) phylo1_0_1
 201
 202
 203 ------------------------------------------------------------------------
 204 -- | STEP 7 | -- Build the coocurency Matrix of the Phylo
 205
 206
 207 phyloCooc :: Map (Int, Int) Double
 208 phyloCooc = fisToCooc phyloFis phylo1_0_1
 209
 210
 211 ------------------------------------------------------------------------
 212 -- | STEP 6 | -- Build the level 1 of the Phylo
 213
 214
 215 phylo1_0_1 :: Phylo
 216 phylo1_0_1 = setLevelLinks (0,1) phylo1_1_0
 217
 218
 219 phylo1_1_0 :: Phylo
 220 phylo1_1_0 = setLevelLinks (1,0) phylo1
 221
 222
 223 phylo1 :: Phylo
 224 phylo1 =  addPhyloLevel (1) phyloFis phylo
 225
 226
 227 ------------------------------------------------------------------------
 228 -- | STEP 5 | -- Create lists of Frequent Items Set and filter them
 229
 230
 231 phyloFis :: Map (Date, Date) [Fis]
 232 phyloFis = filterFisBySupport False 1 (filterFisByNested (docsToFis phyloDocs))
 233
 234
 235 ------------------------------------------------------------------------
 236 -- | STEP 2 | -- Init a Phylo of level 0
 237
 238
 239 -- phylo' :: Phylo
 240 -- phylo' = initPhylo 5 3 corpus actants groupNgramsWithTrees
 241
 242
 243 phylo :: Phylo
 244 phylo = addPhyloLevel 0 phyloDocs phyloBase
 245
 246
 247 phyloDocs :: Map (Date, Date) [Document]
 248 phyloDocs = corpusToDocs groupNgramsWithTrees corpus phyloBase
 249
 250
 251 ------------------------------------------------------------------------
 252 -- | STEP 1 | -- Init the Base of the Phylo from Periods and Foundations
 253
 254
 255 phyloBase :: Phylo
 256 phyloBase = initPhyloBase periods foundations
 257
 258
 259 periods :: [(Date,Date)]
 260 periods = initPeriods 5 3
 261         $ both fst (head corpus,last corpus)
 262
 263
 264 foundations :: Vector Ngrams
 265 foundations = initFoundations actants
 266
 267
 268 ------------------------------------------------------------------------
 269 -- | STEP 0 | -- Let's start with an example
 270
 271
 272 actants :: [Ngrams]
 273 actants = [ "Cleopatre"   , "Ptolemee", "Ptolemee-XIII", "Ptolemee-XIV"
 274           , "Marc-Antoine", "Cesar"   , "Antoine"      , "Octave"  , "Rome"
 275           , "Alexandrie"  , "Auguste" , "Pompee"       , "Cassius" , "Brutus"]
 276
 277
 278 corpus :: [(Date, Text)]
 279 corpus = List.sortOn fst [ (-51,"Cleopatre règne sur l’egypte entre 51 et 30 av. J.-C. avec ses frères-epoux Ptolemee-XIII et Ptolemee-XIV, puis aux côtes du general romain Marc-Antoine. Elle est celèbre pour avoir ete la compagne de Jules Cesar puis d'Antoine, avec lesquels elle a eu plusieurs enfants. Partie prenante dans la guerre civile opposant Antoine à Octave, elle est vaincue à la bataille d'Actium en 31 av. J.-C. Sa defaite va permettre aux Romains de mener à bien la conquête de l’egypte, evenement qui marquera la fin de l'epoque hellenistique."), (-40,"Il existe relativement peu d'informations sur son sejour à Rome, au lendemain de l'assassinat de Cesar, ou sur la periode passee à Alexandrie durant l'absence d'Antoine, entre -40 et -37."), (-48,"L'historiographie antique lui est globalement defavorable car inspiree par son vainqueur, l'empereur Auguste, et par son entourage, dont l'interêt est de la noircir, afin d'en faire l'adversaire malfaisant de Rome et le mauvais genie d'Antoine. On observe par ailleurs que Cesar ne fait aucune mention de sa liaison avec elle dans les Commentaires sur la Guerre civile"), (-69,"Cleopatre est nee au cours de l'hiver -69/-686 probablement à Alexandrie."), (-48,"Pompee a en effet ete le protecteur de Ptolemee XII, le père de Cleopatre et de Ptolemee-XIII dont il se considère comme le tuteur."), (-48,"Ptolemee-XIII et Cleopatre auraient d'ailleurs aide Pompee par l'envoi d'une flotte de soixante navires."), (-48,"Mais le jeune roi Ptolemee-XIII et ses conseillers jugent sa cause perdue et pensent s'attirer les bonnes graces du vainqueur en le faisant assassiner à peine a-t-il pose le pied sur le sol egyptien, près de Peluse, le 30 juillet 48 av. J.-C., sous les yeux de son entourage."), (-48,"Cesar fait enterrer la tête de Pompee dans le bosquet de Nemesis en bordure du mur est de l'enceinte d'Alexandrie. Pour autant la mort de Pompee est une aubaine pour Cesar qui tente par ailleurs de profiter des querelles dynastiques pour annexer l’egypte."), (-48,"Il est difficile de se prononcer clairement sur les raisons qui ont pousse Cesar à s'attarder à Alexandrie. Il y a des raisons politiques, mais aussi des raisons plus sentimentales (Cleopatre ?). Il tente d'abord d'obtenir le remboursement de dettes que Ptolemee XII"), (-46,"Les deux souverains sont convoques par Cesar au palais royal d'Alexandrie. Ptolemee-XIII s'y rend après diverses tergiversations ainsi que Cleopatre."), (-47,"A Rome, Cleopatre epouse alors un autre de ses frères cadets, à Alexandrie, Ptolemee-XIV, sur l'injonction de Jules Cesar"), (-46,"Cesar a-t-il comme objectif de montrer ce qu'il en coûte de se revolter contre Rome en faisant figurer dans son triomphe la sœur de Cleopatre et de Ptolemee-XIV, Arsinoe, qui s'est fait reconnaître reine par les troupes de Ptolemee-XIII ?"), (-44,"Au debut de l'annee -44, Cesar est assassine par Brutus. Profitant de la situation confuse qui s'ensuit, Cleopatre quitte alors Rome à la mi-avril, faisant escale en Grèce. Elle parvient à Alexandrie en juillet -44."), (-44,"La guerre que se livrent les assassins de Cesar, Cassius et Brutus et ses heritiers, Octave et Marc-Antoine, oblige Cleopatre à des contorsions diplomatiques."), (-41,"Nous ignorons depuis quand Cleopatre, agee de 29 ans en -41, et Marc-Antoine, qui a une quarantaine d'annees, se connaissent. Marc-Antoine est l'un des officiers qui ont participe au retablissement de Ptolemee XII.  Il est plus vraisemblable qu'ils se soient frequentes lors du sejour à Rome de Cleopatre."), (-42,"Brutus tient la Grèce tandis que Cassius s'installe en Syrie. Le gouverneur de Cleopatre à Chypre, Serapion, vient en aide à Cassius."), (-42,"Cassius aurait envisage de s'emparer d'Alexandrie quand le 'debarquement' en Grèce d'Antoine et d'Octave l'oblige à renoncer à ses projets")]