{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE MultiParamTypeClasses #-}
module Gargantext.Viz.Phylo.Example where
-import qualified Data.List as DL
-import Data.Text (Text, unwords, toLower, words)
-import Data.Tuple.Extra (both)
+import Data.GraphViz.Types.Generalised (DotGraph)
+import Data.Text (Text)
+import Data.List ((++), last)
+import Data.Map (Map)
+import Data.Tuple (fst)
+import Data.Tuple.Extra
+import Data.Vector (Vector)
+import Gargantext.Prelude
+import Gargantext.Text.Context (TermList)
+import Gargantext.Viz.Phylo
+import Gargantext.Viz.Phylo.Aggregates.Cluster
+import Gargantext.Viz.Phylo.Aggregates.Document
+import Gargantext.Viz.Phylo.Aggregates.Fis
+import Gargantext.Viz.Phylo.BranchMaker
+import Gargantext.Viz.Phylo.LevelMaker
+import Gargantext.Viz.Phylo.LinkMaker
+import Gargantext.Viz.Phylo.Tools
+import Gargantext.Viz.Phylo.View.ViewMaker
+import Gargantext.Viz.Phylo.View.Export
+import qualified Data.List as List
-import Data.Map (Map)
-import qualified Data.Map as DM
-import Data.Set (Set)
+------------------------------------------------------
+-- | STEP 12 | -- Create a PhyloView from a user Query
+------------------------------------------------------
-import Gargantext.Text.Metrics.FrequentItemSet (fisWithSizePolyMap, Size(..))
-import Gargantext.Text.Terms.Mono (monoTexts)
-import Gargantext.Prelude
-import Gargantext.Viz.Phylo (Phylo)
+export :: IO ()
+export = dotToFile "/home/qlobbe/data/epique/output/cesar_cleopatre.dot" phyloDot
-------------------------------------------------------------------------
--- | For this example Date is simply an Integer
-type Date = Int
-type Corpus = [Document]
-data Document =
- Document
- { date :: Date
- , text :: Text
- }
- deriving (Show)
-
-type Ngrams = Text
-type MapList = [Ngrams]
-type PeriodeSize = Int
--- data Periodes b a = Map (b,b) a
-type Occurrences = Int
+phyloDot :: DotGraph DotId
+phyloDot = viewToDot phyloView
+phyloView :: PhyloView
+phyloView = toPhyloView (queryParser' queryViewEx) phyloFromQuery
-------------------------------------------------------------------------
--- | Phylo'' ?
--- | phylo_id = date && source data && query && [operations]
--- | node_type = 0 | 1 | 2 | 3 <=> root | emergence | recombination | steady
+-- | To do : create an other request handler and an other query parser
+queryParser' :: [Char] -> PhyloQueryView
+queryParser' _q = phyloQueryView
-data Phylo'' a = Phylo'' { phylo_id :: a
- , branch_list :: [Branch a]
- }
+queryViewEx :: [Char]
+queryViewEx = "level=3"
+ ++ "&childs=false"
+ ++ "&filter=LonelyBranchFilter"
+ ++ "&metric=BranchAge"
+ ++ "&tagger=BranchPeakFreq"
+ ++ "&tagger=GroupLabelCooc"
-data Branch a = Branch { branch_id :: Int
- , cluster_list :: [Cluster' a]
- , cluster_edge :: [Edge a]
- }
-data Cluster' a = Cluster' { cluster_node :: Node a
- , cluster_date :: Date
- , term_list :: [Node a]
- , term_edge :: [Edge a]
- }
+phyloQueryView :: PhyloQueryView
+phyloQueryView = PhyloQueryView 1 Merge False 1 [BranchAge] [] [BranchPeakFreq,GroupLabelCooc] (Just (ByBranchAge,Asc)) Json Flat True
-data Edge a = Edge { edge_id :: Int
- , edge_source :: Node a
- , edge_target :: Node a
- }
+--------------------------------------------------
+-- | STEP 11 | -- Create a Phylo from a user Query
+--------------------------------------------------
-data Node a = Node { node_id :: Int
- , node_label :: Ngrams
- , node_type :: a
- , node_score :: a
- }
-------------------------------------------------------------------------
--- | Phylo == Phylo' ?
-type Phylo' a = [Strate a]
+phyloFromQuery :: Phylo
+phyloFromQuery = toPhylo (queryParser queryEx) corpus actants termList
-data Strate a = Strate { strate_date :: (Date,Date)
- , strate_clusters :: [Cluster a]
- }
+-- | To do : create a request handler and a query parser
+queryParser :: [Char] -> PhyloQueryBuild
+queryParser _q = phyloQueryBuild
-data Cluster a = Cluster { cluster_id :: Int
- , cluster_ngrams :: Set Ngrams
- , cluster_score :: a
- , cluster_parent :: [(Cluster a, Double)]
- }
+queryEx :: [Char]
+queryEx = "title=Cesar et Cleôpatre"
+ ++ "&desc=An example of Phylomemy (french without accent)"
+ ++ "grain=5&steps=3"
+ ++ "cluster=FrequentItemSet"
+ ++ "interTemporalMatching=WeightedLogJaccard"
+ ++ "nthLevel=2"
+ ++ "nthCluster=RelatedComponents"
+ ++ "nthProximity=Filiation"
-------------------------------------------------------------------------
-phyloExampleFinal :: Phylo
-phyloExampleFinal = undefined
+phyloQueryBuild :: PhyloQueryBuild
+phyloQueryBuild = PhyloQueryBuild "Cesar et Cleôpatre" "An example of Phylomemy (french without accent)"
+ 5 3 defaultFis [] [] (WeightedLogJaccard $ WLJParams 0.1 10) 2 (RelatedComponents $ RCParams $ WeightedLogJaccard $ WLJParams 0.13 0)
---------------------------------------------------------------------
-appariement :: Map (Date, Date) (Map (Set Ngrams) Int)
-appariement = undefined
+
+----------------------------------------------------------------------------------------------------------------------------
+-- | STEP 10 | -- Incrementaly cluster the PhyloGroups n times, link them through the Periods and build level n of the Phylo
+----------------------------------------------------------------------------------------------------------------------------
+
+
+phylo6 :: Phylo
+phylo6 = toNthLevel 6 defaultWeightedLogJaccard (RelatedComponents (initRelatedComponents (Just defaultWeightedLogJaccard))) phylo3
+
+
+phylo3 :: Phylo
+phylo3 = setPhyloBranches 3
+ $ interTempoMatching Descendant 3 defaultWeightedLogJaccard
+ $ interTempoMatching Ascendant 3 defaultWeightedLogJaccard
+ $ setLevelLinks (2,3)
+ $ addPhyloLevel 3
+ (phyloToClusters 2 (RelatedComponents (initRelatedComponents (Just defaultWeightedLogJaccard))) phyloBranch2)
+ phyloBranch2
+
+
+--------------------------------
+-- | STEP 9 | -- Cluster the Fis
+--------------------------------
+
+
+phyloBranch2 :: Phylo
+phyloBranch2 = setPhyloBranches 2 phylo2_c
+
+
+phylo2_c :: Phylo
+phylo2_c = interTempoMatching Descendant 2 defaultWeightedLogJaccard phylo2_p
+
+
+phylo2_p :: Phylo
+phylo2_p = interTempoMatching Ascendant 2 defaultWeightedLogJaccard phylo2_1_2
+
+
+phylo2_1_2 :: Phylo
+phylo2_1_2 = setLevelLinks (1,2) phylo2
+
+
+-- | phylo2 allready contains the LevelChilds links from 2 to 1
+phylo2 :: Phylo
+phylo2 = addPhyloLevel 2 phyloCluster phyloBranch1
+
+
+phyloCluster :: Map (Date,Date) [PhyloCluster]
+phyloCluster = phyloToClusters 1 (RelatedComponents $ RCParams $ WeightedLogJaccard $ WLJParams 0.05 10) phyloBranch1
+
+
+----------------------------------
+-- | STEP 8 | -- Find the Branches
+----------------------------------
+
+
+phyloBranch1 :: Phylo
+phyloBranch1 = setPhyloBranches 1 phylo1_c
+
+
+--------------------------------------------------------------------
+-- | STEP 7 | -- Link the PhyloGroups of level 1 through the Periods
--------------------------------------------------------------------
-phyloExample :: Map (Date, Date) (Map (Set Ngrams) Int)
-phyloExample = fis phyloTerms
-fis :: Map (Date, Date) [Document]
- -> Map (Date, Date) (Map (Set Ngrams) Int)
-fis = phylo (words . text)
+phylo1_c :: Phylo
+phylo1_c = interTempoMatching Descendant 1 defaultWeightedLogJaccard phylo1_p
-phyloTerms :: Map (Date, Date) [Document]
-phyloTerms = toPeriodes date 5 3 $ cleanCorpus mapList phyloCorpus
-------------------------------------------------------------------------
+phylo1_p :: Phylo
+phylo1_p = interTempoMatching Ascendant 1 defaultWeightedLogJaccard phylo1_0_1
+
+
+-----------------------------------------------
+-- | STEP 6 | -- Build the level 1 of the Phylo
+-----------------------------------------------
+
+
+phylo1_0_1 :: Phylo
+phylo1_0_1 = setLevelLinks (0,1) phylo1_1_0
+
+
+phylo1_1_0 :: Phylo
+phylo1_1_0 = setLevelLinks (1,0) phylo1
+
+
+phylo1 :: Phylo
+phylo1 = addPhyloLevel (1) phyloFis phylo
+
+
+-------------------------------------------------------------------
+-- | STEP 5 | -- Create lists of Frequent Items Set and filter them
+-------------------------------------------------------------------
+
+
+phyloFis :: Map (Date, Date) [PhyloFis]
+phyloFis = filterFis True 1 (filterFisByClique)
+ $ filterFisByNested
+ $ filterFis True 1 (filterFisBySupport) (docsToFis phyloDocs)
+
+
+----------------------------------------
+-- | STEP 2 | -- Init a Phylo of level 0
+----------------------------------------
+
+
+phylo :: Phylo
+phylo = addPhyloLevel 0 phyloDocs phyloBase
+
+
+phyloDocs :: Map (Date, Date) [Document]
+phyloDocs = corpusToDocs corpus phyloBase
--- | TODO: parameters has to be checked
--- | TODO FIS on monotexts
-phylo :: (Document -> [Ngrams])
- -> Map (Date, Date) [Document]
- -> Map (Date, Date) (Map (Set Ngrams) Int)
-phylo f = DM.map (\d -> fisWithSizePolyMap (Segment 1 20) 1 (map f d))
------------------------------------------------------------------------
--- | Create a Map of (time steps) and [documents]
-toPeriodes :: (Ord date, Enum date) => (doc -> date)
- -> Grain -> Step -> [doc] -> Map (date, date) [doc]
-toPeriodes _ _ _ [] = panic "Empty corpus can not have any periods"
-toPeriodes f g s es = DM.fromList $ zip hs $ map (inPeriode f es) hs
- where
- hs = steps g s $ both f (DL.head es, DL.last es)
- ------------------------------------------------------------------------
- -- | select documents by given periods, following steps
- inPeriode :: Ord b => (t -> b) -> [t] -> (b, b) -> [t]
- inPeriode f' h (start,end) =
- fst $ DL.partition (\d -> f' d >= start && f' d <= end) h
- ------------------------------------------------------------------------
- -- | Steps of linear and homogenous time of integer as granalurity measure
- -- chunkAlong deals with [] case (not error with head and last then)
- -- | Split a period of time (first and last date of Corpus) into regular steps
- steps :: (Eq date, Enum date) => Grain -> Step -> (date, date) -> [(date, date)]
- steps s' o' (start,end) = map (\l -> (DL.head l, DL.last l))
- $ chunkAlong s' o' [start .. end]
- ------------------------------------------------------------------------
-
-cleanCorpus :: MapList -> Corpus -> Corpus
-cleanCorpus ml = map (\(Document d t) -> Document d (unwords $ filter (\x -> elem x ml) $ monoTexts t))
-
-mapList :: [Ngrams]
-mapList = map toLower actants
+-- | STEP 1 | -- Init the Base of the Phylo from Periods and Foundations
+------------------------------------------------------------------------
+
+
+phyloBase :: Phylo
+phyloBase = initPhyloBase periods (PhyloFoundations foundationsRoots termList) defaultPhyloParam
+
+periods :: [(Date,Date)]
+periods = initPeriods 5 3
+ $ both fst (head' "Example" corpus,last corpus)
+
+foundationsRoots :: Vector Ngrams
+foundationsRoots = initFoundationsRoots actants
+
+
+--------------------------------------------
+-- | STEP 0 | -- Let's start with an example
+--------------------------------------------
+
+
+-- this is a comment
+
+termList :: TermList
+termList = []
actants :: [Ngrams]
actants = [ "Cleopatre" , "Ptolemee", "Ptolemee-XIII", "Ptolemee-XIV"
, "Marc-Antoine", "Cesar" , "Antoine" , "Octave" , "Rome"
, "Alexandrie" , "Auguste" , "Pompee" , "Cassius" , "Brutus"]
-phyloCorpus :: Corpus --[Document]
-phyloCorpus = map (\(d,t) -> Document d t) phyloExampleCorpus
-
-
-------------------------------------------------------------------------
-phyloExampleCorpus :: [(Date, Text)]
-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")]
-
+corpus :: [(Date, Text)]
+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")]