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
  28 module Gargantext.Viz.Phylo.Example where
  29
  30 import qualified Data.List as List
  31 import Data.Text (Text, unwords, toLower, words)
  32 import Data.Tuple.Extra
  33
  34 import Data.Map (Map)
  35 import qualified Data.Map as Map
  36 import qualified Data.Vector as Vector
  37
  38 import Data.Set (Set)
  39 import qualified Data.Set as DS
  40 import qualified Data.Matrix as DM'
  41
  42 import Gargantext.Text.Metrics.FrequentItemSet (fisWithSizePolyMap, Size(..))
  43 import Gargantext.Text.Terms.Mono (monoTexts)
  44 import Gargantext.Prelude
  45 import Gargantext.Viz.Phylo
  46
  47 ------------------------------------------------------------------------
  48 -- | Types | --
  49
  50
  51 -- | Date : a simple Integer
  52 type Date = Int
  53 -- | Document : a piece of Text linked to a Date
  54 data Document = Document
  55       { date :: Date
  56       , text :: Text
  57       } deriving (Show)
  58 -- | Corpus : a list of Documents
  59 type Corpus   = [Document]
  60
  61
  62 type MapList = [Ngrams]
  63 type PeriodeSize = Int
  64 -- data Periodes b a = Map (b,b) a
  65 type Occurrences = Int
  66
  67 --------------------------------------------------------------------
  68
  69
  70 data PhyloField = PhyloField {
  71     phyloField_id :: Int
  72 }
  73
  74 --------------------------------------------------------------------
  75 phyloExampleFinal :: Phylo
  76 phyloExampleFinal = undefined
  77
  78 --------------------------------------------------------------------
  79 appariement :: Map (Date, Date) (Map (Set Ngrams) Int)
  80 appariement = undefined
  81
  82 --------------------------------------------------------------------
  83
  84 fisToFields :: Fis
  85     -> [PhyloField]
  86 fisToFields = undefined
  87
  88 phyloClusters :: Map (Date,Date) [PhyloField]
  89 phyloClusters = undefined
  90
  91 ------------------------------------------------------------------------
  92 -- | STEP 8 | -- Incrementaly cluster the PhyloGroups n times, link them through the Periods and build level n of the Phylo
  93
  94
  95 ------------------------------------------------------------------------
  96 -- | STEP 7 | -- Link the PhyloGroups of level 1 through the Periods
  97
  98
  99 ------------------------------------------------------------------------
 100 -- | STEP 6 | -- Cluster the Fis and buil level 1 of the Phylo
 101
 102
 103 ------------------------------------------------------------------------
 104 -- | STEP 5 | -- Find the Fis out of Documents and Ngrams and build level 1 of the Phylo
 105
 106
 107 phyloFis :: Map (Date, Date) Fis
 108 phyloFis = termsToFis phyloTerms
 109
 110 termsToFis :: Map (Date, Date) [Document]
 111     -> Map (Date, Date) Fis
 112 termsToFis = corpusToFis (words . text)
 113
 114 -- | TODO: parameters has to be checked
 115 -- | TODO FIS on monotexts
 116 corpusToFis :: (Document -> [Ngrams])
 117       -> Map (Date, Date) [Document]
 118       -> Map (Date, Date) (Map (Set Ngrams) Int)
 119 corpusToFis f = Map.map (\d -> fisWithSizePolyMap (Segment 1 20) 1 (map f d))
 120
 121
 122 ------------------------------------------------------------------------
 123 -- | STEP 4 | -- Build level -1 and 0 of the Phylo
 124
 125
 126
 127 ------------------------------------------------------------------------
 128 -- | STEP 3 | -- Split the Corpus into Periods and reduce each Document as a list of Ngrams
 129
 130
 131 phyloTerms :: Map (Date, Date) [Document]
 132 phyloTerms = toPeriodes date 5 3 $ cleanCorpus cleanedActants phyloCorpus
 133
 134 toPeriodes :: (Ord date, Enum date) => (doc -> date)
 135      -> Grain -> Step -> [doc] -> Map (date, date) [doc]
 136 toPeriodes _ _ _ [] = panic "Empty corpus can not have any periods"
 137 toPeriodes f g s es = Map.fromList $ zip hs $ map (inPeriode f es) hs
 138   where
 139     hs = steps g s $ both f (List.head es, List.last es)
 140     --------------------------------------------------------------------
 141     -- | Define overlapping periods of time by following regular steps
 142     inPeriode :: Ord b => (t -> b) -> [t] -> (b, b) -> [t]
 143     inPeriode f' h (start,end) =
 144       fst $ List.partition (\d -> f' d >= start && f' d <= end) h
 145     --------------------------------------------------------------------
 146     -- | Find steps of linear and homogenous time of integer
 147     steps :: (Eq date, Enum date) => Grain -> Step -> (date, date) -> [(date, date)]
 148     steps s' o' (start,end) = map (\l -> (List.head l, List.last l))
 149                           $ chunkAlong s' o' [start .. end]
 150
 151 cleanCorpus :: MapList -> Corpus -> Corpus
 152 cleanCorpus ml = map (\(Document d t) -> Document d (unwords $ filter (\x -> elem  x ml) $ monoTexts t))
 153
 154
 155 ------------------------------------------------------------------------
 156 -- | STEP 2 | -- Find some Ngrams (ie: phyloGroup of level -1) out of the Corpus & init the phylo
 157
 158
 159 phylo = Phylo (both date $ (List.last &&& List.head) phyloCorpus) (initPhyloNgrams cleanedActants) []
 160
 161 initPhyloNgrams :: [Ngrams] -> PhyloNgrams
 162 initPhyloNgrams n = Vector.fromList n
 163
 164 cleanedActants :: [Ngrams]
 165 cleanedActants = map toLower actants
 166
 167 actants :: [Ngrams]
 168 actants = [ "Cleopatre"   , "Ptolemee", "Ptolemee-XIII", "Ptolemee-XIV"
 169           , "Marc-Antoine", "Cesar"   , "Antoine"      , "Octave"  , "Rome"
 170           , "Alexandrie"  , "Auguste" , "Pompee"       , "Cassius" , "Brutus"]
 171
 172
 173 ------------------------------------------------------------------------
 174 -- | STEP 1 | -- Get a corpus of Documents
 175
 176
 177 phyloCorpus :: Corpus
 178 phyloCorpus = map (\(d,t) -> Document d t) exampleDocuments
 179
 180 exampleDocuments :: [(Date, Text)]
 181 exampleDocuments = 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")]
 182