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                         defaultFis
  98                         defaultWeightedLogJaccard
  99                         2
 100                         defaultRelatedComponents
 101
 102
 103 ------------------------------------------------------------------------
 104 -- | STEP 12 | -- Return a Phylo as a View for upcomming visiualization tasks
 105
 106
 107 -- | To do : add a queryParser from an URL and then update the defaultQuery
 108 urlToQuery :: Text -> PhyloQueryView
 109 urlToQuery url = defaultQuery
 110               & qv_metrics %~ (++ [BranchAge])
 111               & qv_filters %~ (++ [defaultLonelyBranch])
 112               & qv_taggers %~ (++ [BranchLabelFreq,GroupLabelCooc])
 113
 114
 115 defaultQuery :: PhyloQueryView
 116 defaultQuery = PhyloQueryView 3 Descendant False 1 [] [] [] (Just (ByBranchAge,Asc)) Flat True
 117
 118
 119 urlQuery :: Text
 120 urlQuery = "level=3&childs=false&filter=LonelyBranchFilter(2,2,1):true&metric=BranchAge&tagger=BranchLabelFreq&tagger=GroupLabelCooc"
 121
 122
 123 toPhyloView :: Text -> Phylo -> PhyloView
 124 toPhyloView url p = queryToView (urlToQuery url) p
 125
 126
 127 phyloView :: PhyloView
 128 phyloView = toPhyloView urlQuery phylo6
 129
 130
 131 ------------------------------------------------------------------------
 132 -- | STEP 11 | -- Incrementaly cluster the PhyloGroups n times, link them through the Periods and build level n of the Phylo
 133
 134
 135 phylo6 :: Phylo
 136 phylo6 = toNthLevel 6 defaultWeightedLogJaccard defaultRelatedComponents phylo3
 137
 138
 139 phylo3 :: Phylo
 140 phylo3 = setPhyloBranches 3
 141        $ interTempoMatching Descendant 3 defaultWeightedLogJaccard
 142        $ interTempoMatching Ascendant 3 defaultWeightedLogJaccard
 143        $ setLevelLinks (2,3)
 144        $ addPhyloLevel 3
 145           (phyloToClusters 2 defaultWeightedLogJaccard defaultRelatedComponents phyloBranch2)
 146           phyloBranch2
 147
 148
 149 ------------------------------------------------------------------------
 150 -- | STEP 10 | -- Cluster the Fis
 151
 152 phyloBranch2 :: Phylo
 153 phyloBranch2 = setPhyloBranches 2 phylo2_c
 154
 155
 156 phylo2_c :: Phylo
 157 phylo2_c = interTempoMatching Descendant 2 defaultWeightedLogJaccard phylo2_p
 158
 159
 160 phylo2_p :: Phylo
 161 phylo2_p = interTempoMatching Ascendant 2 defaultWeightedLogJaccard phylo2_1_2
 162
 163
 164 phylo2_1_2 :: Phylo
 165 phylo2_1_2 = setLevelLinks (1,2) phylo2
 166
 167
 168 -- | phylo2 allready contains the LevelChilds links from 2 to 1
 169 phylo2 :: Phylo
 170 phylo2 = addPhyloLevel 2 phyloCluster phyloBranch1
 171
 172
 173 phyloCluster :: Map (Date,Date) [PhyloCluster]
 174 phyloCluster = phyloToClusters 1 defaultWeightedLogJaccard defaultRelatedComponents phyloBranch1
 175
 176
 177 ------------------------------------------------------------------------
 178 -- | STEP 9 | -- Find the Branches
 179
 180
 181 phyloBranch1 :: Phylo
 182 phyloBranch1 = setPhyloBranches 1 phylo1_c
 183
 184
 185 ------------------------------------------------------------------------
 186 -- | STEP 8 | -- Link the PhyloGroups of level 1 through the Periods
 187
 188
 189 phylo1_c :: Phylo
 190 phylo1_c = interTempoMatching Descendant 1 defaultWeightedLogJaccard phylo1_p
 191
 192
 193 phylo1_p :: Phylo
 194 phylo1_p = interTempoMatching Ascendant 1 defaultWeightedLogJaccard phylo1_0_1
 195
 196
 197 ------------------------------------------------------------------------
 198 -- | STEP 7 | -- Build the coocurency Matrix of the Phylo
 199
 200
 201 phyloCooc :: Map (Int, Int) Double
 202 phyloCooc = fisToCooc phyloFis phylo1_0_1
 203
 204
 205 ------------------------------------------------------------------------
 206 -- | STEP 6 | -- Build the level 1 of the Phylo
 207
 208
 209 phylo1_0_1 :: Phylo
 210 phylo1_0_1 = setLevelLinks (0,1) phylo1_1_0
 211
 212
 213 phylo1_1_0 :: Phylo
 214 phylo1_1_0 = setLevelLinks (1,0) phylo1
 215
 216
 217 phylo1 :: Phylo
 218 phylo1 =  addPhyloLevel (1) phyloFis phylo
 219
 220
 221 ------------------------------------------------------------------------
 222 -- | STEP 5 | -- Create lists of Frequent Items Set and filter them
 223
 224
 225 phyloFis :: Map (Date, Date) [PhyloFis]
 226 phyloFis = filterFisBySupport False 1 (filterFisByNested (docsToFis phyloDocs))
 227
 228
 229 ------------------------------------------------------------------------
 230 -- | STEP 2 | -- Init a Phylo of level 0
 231
 232
 233 -- phylo' :: Phylo
 234 -- phylo' = initPhylo 5 3 corpus actants groupNgramsWithTrees
 235
 236
 237 phylo :: Phylo
 238 phylo = addPhyloLevel 0 phyloDocs phyloBase
 239
 240
 241 phyloDocs :: Map (Date, Date) [Document]
 242 phyloDocs = corpusToDocs groupNgramsWithTrees corpus phyloBase
 243
 244
 245 ------------------------------------------------------------------------
 246 -- | STEP 1 | -- Init the Base of the Phylo from Periods and Foundations
 247
 248
 249 phyloBase :: Phylo
 250 phyloBase = initPhyloBase periods foundations
 251
 252
 253 periods :: [(Date,Date)]
 254 periods = initPeriods 5 3
 255         $ both fst (head corpus,last corpus)
 256
 257
 258 foundations :: Vector Ngrams
 259 foundations = initFoundations actants
 260
 261
 262 ------------------------------------------------------------------------
 263 -- | STEP 0 | -- Let's start with an example
 264
 265
 266 actants :: [Ngrams]
 267 actants = [ "Cleopatre"   , "Ptolemee", "Ptolemee-XIII", "Ptolemee-XIV"
 268           , "Marc-Antoine", "Cesar"   , "Antoine"      , "Octave"  , "Rome"
 269           , "Alexandrie"  , "Auguste" , "Pompee"       , "Cassius" , "Brutus"]
 270
 271
 272 corpus :: [(Date, Text)]
 273 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")]