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