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 Control.Lens     hiding (makeLenses, both, Level)
  32
  33 import Data.Bool        (Bool, not)
  34 import Data.List        (concat, union, intersect, tails, tail, head, last, null, zip, sort, length, any, (++), (!!), nub, sortOn, reverse, splitAt, take, delete, init, groupBy)
  35 import Data.Map         (Map, elems, member, adjust, singleton, empty, (!), keys, restrictKeys, mapWithKey, filterWithKey, mapKeys, intersectionWith, unionWith)
  36 import Data.Semigroup   (Semigroup)
  37 import Data.Set         (Set)
  38 import Data.Text        (Text, unwords, toLower, words)
  39 import Data.Tuple       (fst, snd)
  40 import Data.Tuple.Extra
  41 import Data.Vector      (Vector, fromList, elemIndex, (!))
  42
  43 import Gargantext.Prelude          hiding (head)
  44 import Gargantext.Text.Terms.Mono  (monoTexts)
  45
  46 import Gargantext.Viz.Phylo
  47 import Gargantext.Viz.Phylo.Aggregates.Cluster
  48 import Gargantext.Viz.Phylo.Aggregates.Cooc
  49 import Gargantext.Viz.Phylo.Aggregates.Document
  50 import Gargantext.Viz.Phylo.Aggregates.Fis
  51 import Gargantext.Viz.Phylo.BranchMaker
  52 import Gargantext.Viz.Phylo.LevelMaker
  53 import Gargantext.Viz.Phylo.LinkMaker
  54 import Gargantext.Viz.Phylo.Metrics.Proximity
  55 import Gargantext.Viz.Phylo.Metrics.Clustering
  56 import Gargantext.Viz.Phylo.Tools
  57
  58
  59 import qualified Data.Bool   as Bool
  60 import qualified Data.List   as List
  61 import qualified Data.Map    as Map
  62 import qualified Data.Maybe  as Maybe
  63 import qualified Data.Set    as Set
  64 import qualified Data.Tuple  as Tuple
  65 import qualified Data.Vector as Vector
  66
  67
  68 ------------------------------------------------------------------------
  69 -- | STEP 12 | -- Return a Phylo for upcomming visiualization tasks
  70
  71
  72 -- | To get all the single PhyloPeriodIds covered by a PhyloBranch
  73 getBranchPeriods :: PhyloBranch -> [PhyloPeriodId]
  74 getBranchPeriods b = nub $ map (fst . fst) $ getBranchGroupIds b
  75
  76
  77 -- | To get all the single PhyloPeriodIds covered by a PhyloBranch
  78 getBranchGroupIds :: PhyloBranch -> [PhyloGroupId]
  79 getBranchGroupIds b =_phylo_branchGroups b
  80
  81
  82 -- | To transform a list of Ngrams Indexes into a Label
  83 ngramsToLabel :: [Int] -> PhyloNgrams -> Text
  84 ngramsToLabel l ngrams = unwords $ ngramsToText l ngrams
  85
  86
  87 -- | To transform a list of Ngrams Indexes into a list of Text
  88 ngramsToText :: [Int] -> PhyloNgrams -> [Text]
  89 ngramsToText l ngrams = map (\idx -> ngrams Vector.! idx) l
  90
  91
  92 -- | To get the nth most frequent Ngrams in a list of PhyloGroups
  93 mostFreqNgrams :: Int -> [PhyloGroup] -> [Int]
  94 mostFreqNgrams thr groups = map fst
  95                           $ take thr
  96                           $ reverse
  97                           $ sortOn snd
  98                           $ map (\g -> (head g,length g))
  99                           $ groupBy (==)
 100                           $ (sort . concat)
 101                           $ map getGroupNgrams groups
 102
 103
 104 -- | To get the (nth `div` 2) most cooccuring Ngrams in a PhyloGroup
 105 mostOccNgrams :: Int -> PhyloGroup -> [Int]
 106 mostOccNgrams thr group = (nub . concat )
 107                         $ map (\((f,s),d) -> [f,s])
 108                         $ take (thr `div` 2)
 109                         $ reverse $ sortOn snd $ Map.toList $ getGroupCooc group
 110
 111
 112
 113 filterLoneBranches :: Int -> Int -> Int -> [PhyloPeriod] -> [PhyloBranch]
 114 filterLoneBranches nbPinf nbPsup nbG periods branches = filter (not . isLone) branches
 115   where
 116     isLone :: PhyloBranch -> Boolean
 117     isLone b = ((length . getBranchGroups) b <= nbG)
 118                && notElem ((head . getBranchPeriods) b) (take nbPinf periods)
 119                && notElem ((head . getBranchPeriods) b) (take nbPsup reverse periods)
 120
 121
 122 toPhyloView :: Level -> Phylo -> [PhyloBranch]
 123 toPhyloView lvl p = branchesLbl
 124   where
 125     branchesLbl = map (\b -> over (phylo_branchLabel) (\lbl -> "toto") b) branches
 126     branches = filter (\b -> (fst . _phylo_branchId) b == lvl) $ getPhyloBranches p
 127
 128 view1 = toPhyloView 2 phylo3
 129
 130 ------------------------------------------------------------------------
 131 -- | STEP 11 | -- Incrementaly cluster the PhyloGroups n times, link them through the Periods and build level n of the Phylo
 132
 133
 134 phylo6 :: Phylo
 135 phylo6 = toNthLevel 6 (WeightedLogJaccard,[0.01,0]) (RelatedComponents, []) (WeightedLogJaccard,[0.01,0]) phylo3
 136
 137
 138 phylo3 :: Phylo
 139 phylo3 = setPhyloBranches 3
 140        $ pairGroupsToGroups Childs  3 (WeightedLogJaccard,[0.01,0])
 141        $ pairGroupsToGroups Parents 3 (WeightedLogJaccard,[0.01,0])
 142        $ setLevelLinks (2,3)
 143        $ addPhyloLevel 3
 144           (phyloToClusters 2 (WeightedLogJaccard,[0.01,0]) (RelatedComponents, []) phyloBranch2)
 145           phyloBranch2
 146
 147
 148 ------------------------------------------------------------------------
 149 -- | STEP 10 | -- Cluster the Fis
 150
 151 phyloBranch2 :: Phylo
 152 phyloBranch2 = setPhyloBranches 2 phylo2_c
 153
 154
 155 phylo2_c :: Phylo
 156 phylo2_c = pairGroupsToGroups Childs 2 (WeightedLogJaccard,[0.01,0]) phylo2_p
 157
 158
 159 phylo2_p :: Phylo
 160 phylo2_p = pairGroupsToGroups Parents 2 (WeightedLogJaccard,[0.01,0]) phylo2_1_2
 161
 162
 163 phylo2_1_2 :: Phylo
 164 phylo2_1_2 = setLevelLinks (1,2) phylo2
 165
 166
 167 -- | phylo2 allready contains the LevelChilds links from 2 to 1
 168 phylo2 :: Phylo
 169 phylo2 = addPhyloLevel 2 phyloCluster phyloBranch1
 170
 171
 172 phyloCluster :: Map (Date,Date) [Cluster]
 173 phyloCluster = phyloToClusters 1 (WeightedLogJaccard,[0.01,0]) (RelatedComponents, []) phyloBranch1
 174
 175
 176 ------------------------------------------------------------------------
 177 -- | STEP 9 | -- Find the Branches
 178
 179
 180 phyloBranch1 :: Phylo
 181 phyloBranch1 = setPhyloBranches 1 phylo1_c
 182
 183
 184 ------------------------------------------------------------------------
 185 -- | STEP 8 | -- Link the PhyloGroups of level 1 through the Periods
 186
 187
 188 phylo1_c :: Phylo
 189 phylo1_c = pairGroupsToGroups Childs 1 (WeightedLogJaccard,[0.01,0]) phylo1_p
 190
 191
 192 phylo1_p :: Phylo
 193 phylo1_p = pairGroupsToGroups Parents 1 (WeightedLogJaccard,[0.01,0]) phylo1_0_1
 194
 195
 196 ------------------------------------------------------------------------
 197 -- | STEP 7 | -- Build the coocurency Matrix of the Phylo
 198
 199
 200 phyloCooc :: Map (Int, Int) Double
 201 phyloCooc = fisToCooc phyloFis phylo1_0_1
 202
 203
 204 ------------------------------------------------------------------------
 205 -- | STEP 6 | -- Build the level 1 of the Phylo
 206
 207
 208 phylo1_0_1 :: Phylo
 209 phylo1_0_1 = setLevelLinks (0,1) phylo1_1_0
 210
 211
 212 phylo1_1_0 :: Phylo
 213 phylo1_1_0 = setLevelLinks (1,0) phylo1
 214
 215
 216 phylo1 :: Phylo
 217 phylo1 =  addPhyloLevel (1) phyloFis phylo0_m1_0
 218
 219
 220 ------------------------------------------------------------------------
 221 -- | STEP 5 | -- Create lists of Frequent Items Set and filter them
 222
 223
 224 phyloFis :: Map (Date, Date) [Fis]
 225 phyloFis = filterFisBySupport False 1 (filterFisByNested (docsToFis phyloDocs))
 226
 227
 228 ------------------------------------------------------------------------
 229 -- | STEP 4 | -- Link level 0 to level -1 and reverse
 230
 231
 232 phylo0_m1_0 :: Phylo
 233 phylo0_m1_0 = setLevelLinks ((-1),0) phylo0_0_m1
 234
 235
 236 phylo0_0_m1 :: Phylo
 237 phylo0_0_m1 = setLevelLinks (0,(-1)) phylo0
 238
 239
 240 ------------------------------------------------------------------------
 241 -- | STEP 3 | -- Build level 0 as a copy of level -1
 242 -- | To do : build a real level 0 !
 243
 244
 245 -- | To clone the last PhyloLevel of each PhyloPeriod and update it with a new LevelValue
 246 clonePhyloLevel :: Level -> Phylo -> Phylo
 247 clonePhyloLevel lvl p = alterPhyloLevels (\l -> l ++ [setPhyloLevelId lvl $ head l]) p
 248
 249
 250 phylo0 :: Phylo
 251 phylo0 = clonePhyloLevel 0 phylo
 252
 253
 254 ------------------------------------------------------------------------
 255 -- | STEP 2 | -- Init a Phylo of level -1 with the Documents
 256
 257
 258 phylo :: Phylo
 259 phylo = addPhyloLevel (-1) phyloDocs
 260         $ initPhylo (keys phyloDocs) (initNgrams actants)
 261
 262
 263 ------------------------------------------------------------------------
 264 -- | STEP 1 | -- Parse all the Documents and group them by Period
 265
 266
 267 phyloDocs :: Map (Date, Date) [Document]
 268 phyloDocs = groupDocsByPeriod 5 3 (corpusToDocs corpus) (initNgrams actants)
 269
 270
 271 ------------------------------------------------------------------------
 272 -- | STEP 0 | -- Let's start with an example
 273
 274
 275 actants :: [Ngrams]
 276 actants = [ "Cleopatre"   , "Ptolemee", "Ptolemee-XIII", "Ptolemee-XIV"
 277           , "Marc-Antoine", "Cesar"   , "Antoine"      , "Octave"  , "Rome"
 278           , "Alexandrie"  , "Auguste" , "Pompee"       , "Cassius" , "Brutus"]
 279
 280
 281 corpus :: [(Date, Text)]
 282 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")]