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
10 -- | Cesar et Cleôpatre
11 -- Exemple de phylomemie
12 -- French without accents
16 - split the functions : RAW -> Document -> Ngrams
18 -- reverse history: antechronologique
24 {-# LANGUAGE NoImplicitPrelude #-}
25 {-# LANGUAGE FlexibleContexts #-}
26 {-# LANGUAGE OverloadedStrings #-}
27 {-# LANGUAGE MultiParamTypeClasses #-}
29 module Gargantext.Viz.Phylo.Example where
31 import Data.GraphViz.Types.Generalised (DotGraph)
32 import Data.Text (Text)
33 import Data.List ((++), last)
35 import Data.Tuple (fst)
36 import Data.Tuple.Extra
37 import Data.Vector (Vector)
38 import Gargantext.Prelude
39 import Gargantext.Text.Context (TermList)
40 import Gargantext.Viz.Phylo
41 import Gargantext.Viz.Phylo.Aggregates.Cluster
42 import Gargantext.Viz.Phylo.Aggregates.Document
43 import Gargantext.Viz.Phylo.Aggregates.Fis
44 import Gargantext.Viz.Phylo.BranchMaker
45 import Gargantext.Viz.Phylo.LevelMaker
46 import Gargantext.Viz.Phylo.LinkMaker
47 import Gargantext.Viz.Phylo.Tools
48 import Gargantext.Viz.Phylo.View.ViewMaker
49 import Gargantext.Viz.Phylo.View.Export
50 import qualified Data.List as List
53 ------------------------------------------------------
54 -- | STEP 12 | -- Create a PhyloView from a user Query
55 ------------------------------------------------------
58 export = dotToFile "/home/qlobbe/data/epique/output/cesar_cleopatre.dot" phyloDot
60 phyloDot :: DotGraph DotId
61 phyloDot = viewToDot phyloView
63 phyloView :: PhyloView
64 phyloView = toPhyloView (queryParser' queryViewEx) phyloFromQuery
66 -- | To do : create an other request handler and an other query parser
67 queryParser' :: [Char] -> PhyloQueryView
68 queryParser' _q = phyloQueryView
71 queryViewEx = "level=3"
73 ++ "&filter=LonelyBranchFilter"
74 ++ "&metric=BranchAge"
75 ++ "&tagger=BranchPeakFreq"
76 ++ "&tagger=GroupLabelCooc"
79 phyloQueryView :: PhyloQueryView
80 phyloQueryView = PhyloQueryView 1 Merge False 1 [BranchAge] [] [BranchPeakFreq,GroupLabelCooc] (Just (ByBranchAge,Asc)) Json Flat True
83 --------------------------------------------------
84 -- | STEP 11 | -- Create a Phylo from a user Query
85 --------------------------------------------------
88 phyloFromQuery :: Phylo
89 phyloFromQuery = toPhylo (queryParser queryEx) corpus actants termList
91 -- | To do : create a request handler and a query parser
92 queryParser :: [Char] -> PhyloQueryBuild
93 queryParser _q = phyloQueryBuild
96 queryEx = "title=Cesar et Cleôpatre"
97 ++ "&desc=An example of Phylomemy (french without accent)"
99 ++ "cluster=FrequentItemSet"
100 ++ "interTemporalMatching=WeightedLogJaccard"
102 ++ "nthCluster=RelatedComponents"
103 ++ "nthProximity=Filiation"
105 phyloQueryBuild :: PhyloQueryBuild
106 phyloQueryBuild = PhyloQueryBuild "Cesar et Cleôpatre" "An example of Phylomemy (french without accent)"
107 5 3 defaultFis [] [] (WeightedLogJaccard $ WLJParams 0.1 10) 2 (RelatedComponents $ RCParams $ WeightedLogJaccard $ WLJParams 0.13 0)
111 ----------------------------------------------------------------------------------------------------------------------------
112 -- | STEP 10 | -- Incrementaly cluster the PhyloGroups n times, link them through the Periods and build level n of the Phylo
113 ----------------------------------------------------------------------------------------------------------------------------
117 phylo6 = toNthLevel 6 defaultWeightedLogJaccard (RelatedComponents (initRelatedComponents (Just defaultWeightedLogJaccard))) phylo3
121 phylo3 = setPhyloBranches 3
122 $ interTempoMatching Descendant 3 defaultWeightedLogJaccard
123 $ interTempoMatching Ascendant 3 defaultWeightedLogJaccard
124 $ setLevelLinks (2,3)
126 (phyloToClusters 2 (RelatedComponents (initRelatedComponents (Just defaultWeightedLogJaccard))) phyloBranch2)
130 --------------------------------
131 -- | STEP 9 | -- Cluster the Fis
132 --------------------------------
135 phyloBranch2 :: Phylo
136 phyloBranch2 = setPhyloBranches 2 phylo2_c
140 phylo2_c = interTempoMatching Descendant 2 defaultWeightedLogJaccard phylo2_p
144 phylo2_p = interTempoMatching Ascendant 2 defaultWeightedLogJaccard phylo2_1_2
148 phylo2_1_2 = setLevelLinks (1,2) phylo2
151 -- | phylo2 allready contains the LevelChilds links from 2 to 1
153 phylo2 = addPhyloLevel 2 phyloCluster phyloBranch1
156 phyloCluster :: Map (Date,Date) [PhyloCluster]
157 phyloCluster = phyloToClusters 1 (RelatedComponents $ RCParams $ WeightedLogJaccard $ WLJParams 0.05 10) phyloBranch1
160 ----------------------------------
161 -- | STEP 8 | -- Find the Branches
162 ----------------------------------
165 phyloBranch1 :: Phylo
166 phyloBranch1 = setPhyloBranches 1 phylo1_c
169 --------------------------------------------------------------------
170 -- | STEP 7 | -- Link the PhyloGroups of level 1 through the Periods
171 --------------------------------------------------------------------
175 phylo1_c = interTempoMatching Descendant 1 defaultWeightedLogJaccard phylo1_p
179 phylo1_p = interTempoMatching Ascendant 1 defaultWeightedLogJaccard phylo1_0_1
182 -----------------------------------------------
183 -- | STEP 6 | -- Build the level 1 of the Phylo
184 -----------------------------------------------
188 phylo1_0_1 = setLevelLinks (0,1) phylo1_1_0
192 phylo1_1_0 = setLevelLinks (1,0) phylo1
196 phylo1 = addPhyloLevel (1) phyloFis phylo
199 -------------------------------------------------------------------
200 -- | STEP 5 | -- Create lists of Frequent Items Set and filter them
201 -------------------------------------------------------------------
204 phyloFis :: Map (Date, Date) [PhyloFis]
205 phyloFis = filterFis True 1 (filterFisByClique)
207 $ filterFis True 1 (filterFisBySupport) (docsToFis phyloDocs)
210 ----------------------------------------
211 -- | STEP 2 | -- Init a Phylo of level 0
212 ----------------------------------------
216 phylo = addPhyloLevel 0 phyloDocs phyloBase
219 phyloDocs :: Map (Date, Date) [Document]
220 phyloDocs = corpusToDocs corpus phyloBase
223 ------------------------------------------------------------------------
224 -- | STEP 1 | -- Init the Base of the Phylo from Periods and Foundations
225 ------------------------------------------------------------------------
229 phyloBase = initPhyloBase periods (PhyloFoundations foundationsRoots termList) defaultPhyloParam
231 periods :: [(Date,Date)]
232 periods = initPeriods 5 3
233 $ both fst (head' "Example" corpus,last corpus)
235 foundationsRoots :: Vector Ngrams
236 foundationsRoots = initFoundationsRoots actants
239 --------------------------------------------
240 -- | STEP 0 | -- Let's start with an example
241 --------------------------------------------
247 actants = [ "Cleopatre" , "Ptolemee", "Ptolemee-XIII", "Ptolemee-XIV"
248 , "Marc-Antoine", "Cesar" , "Antoine" , "Octave" , "Rome"
249 , "Alexandrie" , "Auguste" , "Pompee" , "Cassius" , "Brutus"]
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")]