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