src/Gargantext/Core/Viz/Phylo/Example.hs

   1 {-|
   2 Module      : Gargantext.Core.Viz.Phylo.PhyloExample
   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
  16 module Gargantext.Core.Viz.Phylo.Example where
  17
  18 import Control.Lens
  19 import Data.GraphViz.Types.Generalised (DotGraph)
  20 import Data.List (sortOn, nub, sort)
  21 import Data.Map.Strict (Map)
  22 import Data.Text (Text, toLower)
  23 import Gargantext.Core.Text.Context (TermList)
  24 import Gargantext.Core.Text.Terms.Mono (monoTexts)
  25 import Gargantext.Core.Viz.Phylo
  26 import Gargantext.Core.Viz.Phylo.PhyloExport
  27 import Gargantext.Core.Viz.Phylo.PhyloMaker
  28 import Gargantext.Core.Viz.Phylo.PhyloTools
  29 import Gargantext.Core.Viz.Phylo.SynchronicClustering (synchronicClustering)
  30 import Gargantext.Core.Viz.Phylo.TemporalMatching (temporalMatching)
  31 import Gargantext.Prelude
  32 import qualified Data.Vector as Vector
  33 import qualified Data.Set as Set
  34
  35 ---------------------------------
  36 -- | STEP 5 | -- Export the phylo
  37 ---------------------------------
  38
  39 phyloExport :: IO ()
  40 phyloExport = dotToFile "/home/qlobbe/data/phylo/output/cesar_cleopatre_V2.dot" phyloDot
  41
  42 phyloDot :: DotGraph DotId
  43 phyloDot = toPhyloExport phyloCleopatre
  44
  45 --------------------------------------------------
  46 -- | STEP 4 | -- Process the synchronic clustering
  47 --------------------------------------------------
  48
  49 phyloCleopatre :: Phylo
  50 phyloCleopatre = synchronicClustering $ toHorizon flatPhylo
  51
  52 -----------------------------------------------
  53 -- | STEP 3 | -- Build the Level 1 of the Phylo
  54 -----------------------------------------------
  55
  56 flatPhylo :: Phylo
  57 flatPhylo = case (getSeaElevation emptyPhylo) of
  58     Constante s g   -> temporalMatching (constDiachronicLadder s g Set.empty)
  59        $ scanSimilarity 1
  60        $ appendGroups clusterToGroup 1 seriesOfClustering emptyPhylo
  61     Adaptative s    -> temporalMatching (adaptDiachronicLadder s (emptyPhylo' ^. phylo_diaSimScan) Set.empty) emptyPhylo'
  62
  63 emptyPhylo' :: Phylo
  64 emptyPhylo' = scanSimilarity 1
  65             $ appendGroups clusterToGroup 1 seriesOfClustering emptyPhylo
  66
  67 ---------------------------------------------
  68 -- | STEP 2 | -- Build the cliques
  69 ---------------------------------------------
  70
  71
  72 seriesOfClustering :: Map (Date,Date) [Clustering]
  73 seriesOfClustering = toSeriesOfClustering emptyPhylo docsByPeriods
  74
  75
  76 docsByPeriods :: Map (Date,Date) [Document]
  77 docsByPeriods = groupDocsByPeriod date periods docs
  78
  79
  80 ---------------------------------
  81 -- | STEP 1 | -- Init the Phylo
  82 ---------------------------------
  83
  84
  85 emptyPhylo :: Phylo
  86 emptyPhylo = initPhylo docs mapList config
  87
  88
  89 phyloCooc :: Map Date Cooc
  90 phyloCooc = docsToTimeScaleCooc docs (foundations ^. foundations_roots)
  91
  92
  93 periods :: [(Date,Date)]
  94 periods = toPeriods (sort $ nub $ map date docs)
  95                     (getTimePeriod $ timeUnit config)
  96                     (getTimeStep $ timeUnit config)
  97
  98
  99 nbDocsByYear :: Map Date Double
 100 nbDocsByYear = docsToTimeScaleNb docs
 101
 102
 103 config :: PhyloConfig
 104 config =
 105     defaultConfig { phyloName  = "Cesar et Cleopatre"
 106                   , phyloScale = 2
 107                   , seaElevation   = Adaptative 4
 108                   , exportFilter = [ByBranchSize 0]
 109                   , clique = MaxClique 0 15 ByNeighbours }
 110
 111
 112 docs :: [Document]
 113 docs = map (\(d,t)
 114     -> Document (d+102)
 115                 ""
 116                 (filter (\n -> isRoots n (foundations ^. foundations_roots)) $ monoTexts t)
 117                 Nothing
 118                 []
 119             ) corpus
 120
 121
 122 foundations :: PhyloFoundations
 123 foundations = PhyloFoundations (Vector.fromList $ map toLower actants) mapList
 124
 125
 126 --------------------------------------------
 127 -- | STEP 0 | -- Let's start with an example
 128 --------------------------------------------
 129
 130
 131 mapList :: TermList
 132 mapList = map (\a -> ([toLower a],[])) actants
 133
 134
 135 actants :: [Ngrams]
 136 actants = [ "Cleopatre"   , "Ptolemee", "Ptolemee-XIII", "Ptolemee-XIV", "Ptolemee-X", "Berenice-III"
 137           , "Marc-Antoine", "Cesar"   , "Antoine"      , "Octave"  , "Rome"
 138           , "Alexandrie"  , "Auguste" , "Pompee"       , "Cassius" , "Brutus", "Caesar-III", "Aurelia-Cotta", "Pisae", "Pline"]
 139
 140 corpus :: [(Date, Text)]
 141 corpus = sortOn fst [
 142   (-101,"La tutelle Cesar Caesar-III  de sa mère lui étant difficile à endurer, en septembre 101 av. J.-C., Ptolemee-X la fait assassiner et peut enfin régner presque seul puisqu'il partage le pouvoir avec son épouse Berenice-III Cléopâtre Philopator."),
 143   (-99,"Caesar-III est questeur en 99 av. J.-C. ou 98 av. J.-C., et préteur en 92 av. J.-C.."),
 144   (-100,"Caius Julius Caesar-IV — dit Jules Cesar Ptolemee-X — naît vers 100 av. J.-C., il est le fils de Caius Julius Caesar-III et de Aurelia-Cotta"),
 145   (-85,"Caesar-III meurt à Pisae de cause naturelle en 85 av. J.-C. : selon Pline l'Ancien, il décède brusquement en mettant ses chaussures"),
 146   (-53,"Aurelia-Cotta décède peu de temps avant le meurtre de Clodius Pulcher, vers 53 av. J.-C."),
 147   (-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."),
 148   (-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."),
 149   (-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"),
 150   (-69,"Cleopatre est nee au cours de l'hiver -69/-686 probablement à Alexandrie."),
 151   (-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."),
 152   (-48,"Ptolemee-XIII et Cleopatre auraient d'ailleurs aide Pompee par l'envoi d'une flotte de soixante navires."),
 153   (-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."),
 154   (-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."),
 155   (-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"),
 156   (-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."),
 157   (-47,"A Rome, Cleopatre epouse alors un autre de ses frères cadets, à Alexandrie, Ptolemee-XIV, sur l'injonction de Jules Cesar"),
 158   (-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 ?"),
 159   (-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."),
 160   (-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."),
 161   (-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."),
 162   (-42,"Brutus tient la Grèce tandis que Cassius s'installe en Syrie. Le gouverneur de Cleopatre à Chypre, Serapion, vient en aide à Cassius."),
 163   (-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")]