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 Data.GraphViz.Types.Generalised (DotGraph)
  32 import Data.Text (Text)
  33 import Data.List        ((++), last)
  34 import Data.Map         (Map)
  35 import Data.Tuple       (fst)
  36 import Data.Tuple.Extra
  37 import Data.Vector      (Vector)
  38 import Gargantext.Prelude
  39 import Gargantext.Viz.Phylo
  40 import Gargantext.Viz.Phylo.Aggregates.Cluster
  41 import Gargantext.Viz.Phylo.Aggregates.Document
  42 import Gargantext.Viz.Phylo.Aggregates.Fis
  43 import Gargantext.Viz.Phylo.BranchMaker
  44 import Gargantext.Viz.Phylo.LevelMaker
  45 import Gargantext.Viz.Phylo.LinkMaker
  46 import Gargantext.Viz.Phylo.Tools
  47 import Gargantext.Viz.Phylo.View.ViewMaker
  48 import Gargantext.Viz.Phylo.View.Export
  49 import qualified Data.List   as List
  50
  51
  52 ------------------------------------------------------
  53 -- | STEP 12 | -- Create a PhyloView from a user Query
  54 ------------------------------------------------------
  55
  56
  57 phyloDot :: DotGraph DotId
  58 phyloDot = viewToDot phyloView
  59
  60 phyloView :: PhyloView
  61 phyloView = toPhyloView (queryParser' queryViewEx) phyloFromQuery
  62
  63 -- | To do : create an other request handler and an other query parser
  64 queryParser' :: [Char] -> PhyloQueryView
  65 queryParser' _q = phyloQueryView
  66
  67 queryViewEx :: [Char]
  68 queryViewEx = "level=3"
  69               ++ "&childs=false"
  70               ++ "&filter=LonelyBranchFilter"
  71               ++ "&metric=BranchAge"
  72               ++ "&tagger=BranchLabelFreq"
  73               ++ "&tagger=GroupLabelCooc"
  74
  75
  76 phyloQueryView :: PhyloQueryView
  77 phyloQueryView = PhyloQueryView 2 Merge False 1 [BranchAge] [defaultSmallBranch] [BranchLabelFreq,GroupLabelCooc] (Just (ByBranchAge,Asc)) Json Flat True
  78
  79
  80 --------------------------------------------------
  81 -- | STEP 11 | -- Create a Phylo from a user Query
  82 --------------------------------------------------
  83
  84
  85 phyloFromQuery :: Phylo
  86 phyloFromQuery = toPhylo (queryParser queryEx) corpus actants actantsTrees
  87
  88 -- | To do : create a request handler and a query parser
  89 queryParser :: [Char] -> PhyloQueryBuild
  90 queryParser _q = phyloQuery
  91
  92 queryEx :: [Char]
  93 queryEx = "title=Cesar et Cleôpatre"
  94           ++ "&desc=An example of Phylomemy (french without accent)"
  95           ++ "grain=5&steps=3"
  96           ++ "cluster=FrequentItemSet"
  97           ++ "interTemporalMatching=WeightedLogJaccard"
  98           ++ "nthLevel=2"
  99           ++ "nthCluster=RelatedComponents"
 100           ++ "nthProximity=Filiation"
 101
 102 phyloQuery :: PhyloQueryBuild
 103 phyloQuery = PhyloQueryBuild "Cesar et Cleôpatre" "An example of Phylomemy (french without accent)"
 104              5 3 defaultFis [] [] defaultWeightedLogJaccard 3 defaultRelatedComponents
 105
 106
 107
 108 ----------------------------------------------------------------------------------------------------------------------------
 109 -- | STEP 10 | -- Incrementaly cluster the PhyloGroups n times, link them through the Periods and build level n of the Phylo
 110 ----------------------------------------------------------------------------------------------------------------------------
 111
 112
 113 phylo6 :: Phylo
 114 phylo6 = toNthLevel 6 defaultWeightedLogJaccard defaultRelatedComponents phylo3
 115
 116
 117 phylo3 :: Phylo
 118 phylo3 = setPhyloBranches 3
 119        $ interTempoMatching Descendant 3 defaultWeightedLogJaccard
 120        $ interTempoMatching Ascendant 3 defaultWeightedLogJaccard
 121        $ setLevelLinks (2,3)
 122        $ addPhyloLevel 3
 123           (phyloToClusters 2 defaultWeightedLogJaccard defaultRelatedComponents phyloBranch2)
 124           phyloBranch2
 125
 126
 127 --------------------------------
 128 -- | STEP 9 | -- Cluster the Fis
 129 --------------------------------
 130
 131
 132 phyloBranch2 :: Phylo
 133 phyloBranch2 = setPhyloBranches 2 phylo2_c
 134
 135
 136 phylo2_c :: Phylo
 137 phylo2_c = interTempoMatching Descendant 2 defaultWeightedLogJaccard phylo2_p
 138
 139
 140 phylo2_p :: Phylo
 141 phylo2_p = interTempoMatching Ascendant 2 defaultWeightedLogJaccard phylo2_1_2
 142
 143
 144 phylo2_1_2 :: Phylo
 145 phylo2_1_2 = setLevelLinks (1,2) phylo2
 146
 147
 148 -- | phylo2 allready contains the LevelChilds links from 2 to 1
 149 phylo2 :: Phylo
 150 phylo2 = addPhyloLevel 2 phyloCluster phyloBranch1
 151
 152
 153 phyloCluster :: Map (Date,Date) [PhyloCluster]
 154 phyloCluster = phyloToClusters 1 defaultWeightedLogJaccard defaultRelatedComponents phyloBranch1
 155
 156
 157 ----------------------------------
 158 -- | STEP 8 | -- Find the Branches
 159 ----------------------------------
 160
 161
 162 phyloBranch1 :: Phylo
 163 phyloBranch1 = setPhyloBranches 1 phylo1_c
 164
 165
 166 --------------------------------------------------------------------
 167 -- | STEP 7 | -- Link the PhyloGroups of level 1 through the Periods
 168 --------------------------------------------------------------------
 169
 170
 171 phylo1_c :: Phylo
 172 phylo1_c = interTempoMatching Descendant 1 defaultWeightedLogJaccard phylo1_p
 173
 174
 175 phylo1_p :: Phylo
 176 phylo1_p = interTempoMatching Ascendant 1 defaultWeightedLogJaccard phylo1_0_1
 177
 178
 179 -----------------------------------------------
 180 -- | STEP 6 | -- Build the level 1 of the Phylo
 181 -----------------------------------------------
 182
 183
 184 phylo1_0_1 :: Phylo
 185 phylo1_0_1 = setLevelLinks (0,1) phylo1_1_0
 186
 187
 188 phylo1_1_0 :: Phylo
 189 phylo1_1_0 = setLevelLinks (1,0) phylo1
 190
 191
 192 phylo1 :: Phylo
 193 phylo1 =  addPhyloLevel (1) phyloFis phylo
 194
 195
 196 -------------------------------------------------------------------
 197 -- | STEP 5 | -- Create lists of Frequent Items Set and filter them
 198 -------------------------------------------------------------------
 199
 200
 201 phyloFis :: Map (Date, Date) [PhyloFis]
 202 phyloFis = filterFisByNested $ filterFisBySupport False 1 (docsToFis phyloDocs)
 203
 204
 205 ----------------------------------------
 206 -- | STEP 2 | -- Init a Phylo of level 0
 207 ----------------------------------------
 208
 209
 210 phylo :: Phylo
 211 phylo = addPhyloLevel 0 phyloDocs phyloBase
 212
 213
 214 phyloDocs :: Map (Date, Date) [Document]
 215 phyloDocs = corpusToDocs corpus phyloBase
 216
 217
 218 ------------------------------------------------------------------------
 219 -- | STEP 1 | -- Init the Base of the Phylo from Periods and Foundations
 220 ------------------------------------------------------------------------
 221
 222
 223 phyloBase :: Phylo
 224 phyloBase = initPhyloBase periods foundations peaks defaultPhyloParam
 225
 226
 227 periods :: [(Date,Date)]
 228 periods = initPeriods 5 3
 229         $ both fst (head' "Example" corpus,last corpus)
 230
 231
 232 peaks :: PhyloPeaks
 233 peaks = initPeaks (map (\t -> alterLabels phyloAnalyzer t) actantsTrees) foundations
 234
 235
 236 foundations :: Vector Ngrams
 237 foundations = initFoundations actants
 238
 239
 240 --------------------------------------------
 241 -- | STEP 0 | -- Let's start with an example
 242 --------------------------------------------
 243
 244 actantsTrees :: [Tree Ngrams]
 245 actantsTrees = [Node "Cite antique" [(Node "Rome" []),(Node "Alexandrie" [])]]
 246
 247
 248 actants :: [Ngrams]
 249 actants = [ "Cleopatre"   , "Ptolemee", "Ptolemee-XIII", "Ptolemee-XIV"
 250           , "Marc-Antoine", "Cesar"   , "Antoine"      , "Octave"  , "Rome"
 251           , "Alexandrie"  , "Auguste" , "Pompee"       , "Cassius" , "Brutus"]
 252
 253
 254 corpus :: [(Date, Text)]
 255 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")]