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