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