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