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 DL
  31 import Data.Text (Text, unwords, toLower, words)
  32 import Data.Tuple.Extra (both)
  33
  34 import Data.Map (Map)
  35 import qualified Data.Map as DM
  36
  37 import Data.Set (Set)
  38
  39 import Gargantext.Text.Metrics.FrequentItemSet (fisWithSizePolyMap, Size(..))
  40 import Gargantext.Text.Terms.Mono (monoTexts)
  41 import Gargantext.Prelude
  42 import Gargantext.Viz.Phylo (Phylo)
  43
  44 ------------------------------------------------------------------------
  45 -- | For this example Date is simply an Integer
  46 type Date     = Int
  47 type Corpus   = [Document]
  48 data Document =
  49      Document
  50      { date :: Date
  51      , text :: Text
  52      }
  53   deriving (Show)
  54
  55 type Ngrams  = Text
  56 type MapList = [Ngrams]
  57 type PeriodeSize = Int
  58 -- data Periodes b a = Map (b,b) a
  59 type Occurrences = Int
  60
  61
  62
  63
  64 ------------------------------------------------------------------------
  65 -- | Phylo == Phylo' ?
  66 type Phylo' a = [Strate a]
  67
  68 data Strate a = Strate { strate_date     :: (Date,Date)
  69                        , strate_clusters :: [Cluster a]
  70                        }
  71
  72 data Cluster a = Cluster { cluster_id :: Int
  73                          , cluster_ngrams :: Set Ngrams
  74                          , cluster_score  :: a
  75                          , cluster_parent :: [(Cluster a, Double)]
  76                          }
  77
  78 ------------------------------------------------------------------------
  79 phyloExampleFinal :: Phylo
  80 phyloExampleFinal = undefined
  81
  82 --------------------------------------------------------------------
  83 appariement :: Map (Date, Date) (Map (Set Ngrams) Int)
  84 appariement = undefined
  85
  86 --------------------------------------------------------------------
  87
  88 phyloExample :: Map (Date, Date) (Map (Set Ngrams) Int)
  89 phyloExample = fis phyloTerms
  90
  91 fis :: Map (Date, Date) [Document]
  92     -> Map (Date, Date) (Map (Set Ngrams) Int)
  93 fis = phylo (words . text)
  94
  95 phyloTerms :: Map (Date, Date) [Document]
  96 phyloTerms = toPeriodes date 5 3 $ cleanCorpus mapList phyloCorpus
  97
  98 ------------------------------------------------------------------------
  99
 100 -- | TODO: parameters has to be checked
 101 -- | TODO FIS on monotexts
 102 phylo :: (Document -> [Ngrams])
 103       -> Map (Date, Date) [Document]
 104       -> Map (Date, Date) (Map (Set Ngrams) Int)
 105 phylo f = DM.map (\d -> fisWithSizePolyMap (Segment 1 20) 1 (map f d))
 106 ------------------------------------------------------------------------
 107 toPeriodes :: (Ord date, Enum date) => (doc -> date)
 108      -> Grain -> Step -> [doc] -> Map (date, date) [doc]
 109 toPeriodes _ _ _ [] = panic "Empty corpus can not have any periods"
 110 toPeriodes f g s es = DM.fromList $ zip hs $ map (inPeriode f es) hs
 111   where
 112     hs = steps g s $ both f (DL.head es, DL.last es)
 113
 114     inPeriode :: Ord b => (t -> b) -> [t] -> (b, b) -> [t]
 115     inPeriode f' h (start,end) =
 116       fst $ DL.partition (\d -> f' d >= start && f' d <= end) h
 117     ------------------------------------------------------------------------
 118     -- | Steps of linear and homogenous time of integer as granalurity measure
 119     -- chunkAlong deals with [] case (not error with head and last then)
 120     steps :: (Eq date, Enum date) => Grain -> Step -> (date, date) -> [(date, date)]
 121     steps s' o' (start,end) = map (\l -> (DL.head l, DL.last l))
 122                           $ chunkAlong s' o' [start .. end]
 123     ------------------------------------------------------------------------
 124
 125 cleanCorpus :: MapList -> Corpus -> Corpus
 126 cleanCorpus ml = map (\(Document d t) -> Document d (unwords $ filter (\x -> elem  x ml) $ monoTexts t))
 127
 128 mapList :: [Ngrams]
 129 mapList = map toLower actants
 130
 131 actants :: [Ngrams]
 132 actants = [ "Cleopatre"   , "Ptolemee", "Ptolemee-XIII", "Ptolemee-XIV"
 133           , "Marc-Antoine", "Cesar"   , "Antoine"      , "Octave"  , "Rome"
 134           , "Alexandrie"  , "Auguste" , "Pompee"       , "Cassius" , "Brutus"]
 135
 136 phyloCorpus :: Corpus --[Document]
 137 phyloCorpus = map (\(d,t) -> Document d t) phyloExampleCorpus
 138
 139
 140 ------------------------------------------------------------------------
 141 phyloExampleCorpus :: [(Date, Text)]
 142 phyloExampleCorpus = DL.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")]
 143