[docker] update image, add README info
[gargantext.git] / src / Gargantext / Viz / Phylo / Example.hs
index 9abee1ff93d2fa235470f5777723e12c951755b3..5455bd4a29b2961865c808e2becfcded390262c5 100644 (file)
@@ -28,126 +28,115 @@ TODO:
 
 module Gargantext.Viz.Phylo.Example where
 
-import Control.Lens     hiding (makeLenses, both, Level)
-
-import Data.Bool        (Bool, not)
-import Data.List        ((\\), notElem, concat, union, intersect, tails, tail, head, last, null, zip, sort, length, any, (++), (!!), nub, sortOn, reverse, splitAt, take, delete, init, groupBy)
-import Data.Map         (Map, elems, insert, member, adjust, singleton, empty, (!), keys, restrictKeys, mapWithKey, filterWithKey, mapKeys, intersectionWith, unionWith)
-import Data.Maybe       (mapMaybe,isJust,fromJust, isNothing)
-import Data.Semigroup   (Semigroup)
-import Data.Set         (Set)
-import Data.Text        (Text, unwords, toLower, words)
-import Data.Tuple       (fst, snd)
-import Data.Tuple.Extra
-import Data.Vector      (Vector, fromList, elemIndex, (!))
-
-import Debug.Trace      (trace)
-
-import Gargantext.Prelude          hiding (head)
-import Gargantext.Text.Terms.Mono  (monoTexts)
-
+import Data.GraphViz.Types.Generalised (DotGraph)
+
+import Control.Lens hiding (both, Level)
+import Data.Text (Text, toLower)
+import Data.List        ((++))
+import Data.Map         (Map,empty)
+import Data.Tuple       (fst)
+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.Cooc
-import Gargantext.Viz.Phylo.Aggregates.Document 
-import Gargantext.Viz.Phylo.Aggregates.Fis                   
+import Gargantext.Viz.Phylo.Cluster
+import Gargantext.Viz.Phylo.Aggregates
 import Gargantext.Viz.Phylo.BranchMaker
 import Gargantext.Viz.Phylo.LevelMaker
 import Gargantext.Viz.Phylo.LinkMaker
-import Gargantext.Viz.Phylo.Metrics.Proximity
-import Gargantext.Viz.Phylo.Metrics.Clustering
 import Gargantext.Viz.Phylo.Tools
-import Gargantext.Viz.Phylo.View.Display
-import Gargantext.Viz.Phylo.View.Filters
-import Gargantext.Viz.Phylo.View.Metrics
-import Gargantext.Viz.Phylo.View.Sort
-import Gargantext.Viz.Phylo.View.Taggers
 import Gargantext.Viz.Phylo.View.ViewMaker
-
-
-import qualified Data.Bool   as Bool
+import Gargantext.Viz.Phylo.View.Export
+import Gargantext.Viz.Phylo.Main (writePhylo)
+import GHC.IO (FilePath)
 import qualified Data.List   as List
-import qualified Data.Map    as Map
-import qualified Data.Maybe  as Maybe
-import qualified Data.Set    as Set
-import qualified Data.Tuple  as Tuple
-import qualified Data.Vector as Vector
 
-
-------------------------------------------------------------------------
--- | STEP 13 | -- Create a Phylo from a Rest request 
+------------------------------------------------------
+-- | STEP 12 | -- Create a PhyloView from a user Query
+------------------------------------------------------
 
 
-phylo' :: Phylo
-phylo' = toPhylo phyloQuery corpus actants
+export :: IO ()
+export = dotToFile "/home/qlobbe/data/phylo/output/cesar_cleopatre.dot" phyloDot 
 
+phyloDot :: DotGraph DotId
+phyloDot = viewToDot phyloView
 
-urlPhyloQuery :: [Char]
-urlPhyloQuery = "title=Cesar et Cleôpatre&description=An example of Phylomemy (french without accent)" 
-                ++ "grain=5&step=3"
-                ++ "fstCluster=FrequentItemSet&fstClusterParam=supportInf:1&fstClusterParam=filterFis:True&fstClusterParam=emptyFis:False"
-                ++ "timeMatching=WeightedLogJaccard&timeMatchingParam=sensibility:0&timeMatchingThreshold:0.01"
-                ++ "levelMax=2"
-                ++ "cluster=RelatedComponents&clusterProximity=Filiation"
 
+phyloExport :: FilePath -> IO FilePath
+phyloExport fp = writePhylo fp phyloView
 
-phyloQuery :: PhyloQuery
-phyloQuery = PhyloQuery "Cesar et Cleôpatre" "An example of Phylomemy (french without accent)"
-                        5 3
-                        defaultFis
-                        defaultWeightedLogJaccard
-                        2
-                        defaultRelatedComponents
+phyloView :: PhyloView
+phyloView = toPhyloView (queryParser' queryViewEx) phyloFromQuery
 
+-- | To do : create an other request handler and an other query parser
+queryParser' :: [Char] -> PhyloQueryView
+queryParser' _q = phyloQueryView
 
-------------------------------------------------------------------------
--- | STEP 12 | -- Return a Phylo as a View for upcomming visiualization tasks 
+queryViewEx :: [Char]
+queryViewEx = "level=3"
+              ++ "&childs=false"
+              ++ "&filter=LonelyBranchFilter"
+              ++ "&metric=BranchAge"
+              ++ "&tagger=BranchPeakFreq"
+              ++ "&tagger=GroupLabelCooc"
 
 
--- | To do : add a queryParser from an URL and then update the defaultQuery
-urlToQuery :: Text -> PhyloQueryView
-urlToQuery url = defaultQuery 
-              & qv_metrics %~ (++ [BranchAge])
-              & qv_filters %~ (++ [defaultLonelyBranch])
-              & qv_taggers %~ (++ [BranchLabelFreq,GroupLabelCooc])
+phyloQueryView :: PhyloQueryView
+phyloQueryView = PhyloQueryView 1 Merge False 1 [BranchAge,BranchBirth,BranchGroups] [] [BranchPeakInc,GroupLabelIncDyn] (Just (ByBranchBirth,Asc)) Json Flat True
 
 
-defaultQuery :: PhyloQueryView
-defaultQuery = PhyloQueryView 3 Descendant False 1 [] [] [] (Just (ByBranchAge,Asc)) Flat True
+--------------------------------------------------
+-- | STEP 11 | -- Create a Phylo from a user Query
+--------------------------------------------------
 
 
-urlQuery :: Text
-urlQuery = "level=3&childs=false&filter=LonelyBranchFilter(2,2,1):true&metric=BranchAge&tagger=BranchLabelFreq&tagger=GroupLabelCooc"
+phyloFromQuery :: Phylo
+phyloFromQuery = toPhylo phyloQueryBuild docs termList empty
 
+-- | To do : create a request handler and a query parser
+queryParser :: [Char] -> PhyloQueryBuild
+queryParser _q = phyloQueryBuild
 
-toPhyloView :: Text -> Phylo -> PhyloView
-toPhyloView url p = queryToView (urlToQuery url) p
+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"
 
+phyloQueryBuild :: PhyloQueryBuild
+phyloQueryBuild = PhyloQueryBuild "Cesar et Cleôpatre" "An example of Phylomemy (french without accent)"
+             3 1 defaultFis [] [] (WeightedLogJaccard $ WLJParams 0.9 10) 5 0.8 0.5 4 1 (RelatedComponents $ RCParams $ WeightedLogJaccard $ WLJParams 0.3 0) 
 
-phyloView :: PhyloView
-phyloView = toPhyloView urlQuery phylo6
 
 
-------------------------------------------------------------------------
--- | STEP 11 | -- Incrementaly cluster the PhyloGroups n times, link them through the Periods and build level n of the Phylo   
+----------------------------------------------------------------------------------------------------------------------------
+-- | 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 defaultRelatedComponents phylo3  
+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 defaultWeightedLogJaccard defaultRelatedComponents phyloBranch2) 
+       $ setLevelLinks (2,3)
+       $ addPhyloLevel 3
+          (phyloToClusters 2 (RelatedComponents (initRelatedComponents (Just defaultWeightedLogJaccard))) phyloBranch2)
           phyloBranch2
 
 
-------------------------------------------------------------------------
--- | STEP 10 | -- Cluster the Fis
+--------------------------------
+-- | STEP 9 | -- Cluster the Fis
+--------------------------------
+
 
 phyloBranch2 :: Phylo
 phyloBranch2 = setPhyloBranches 2 phylo2_c
@@ -170,20 +159,22 @@ phylo2 :: Phylo
 phylo2 = addPhyloLevel 2 phyloCluster phyloBranch1
 
 
-phyloCluster :: Map (Date,Date) [PhyloCluster] 
-phyloCluster = phyloToClusters 1 defaultWeightedLogJaccard defaultRelatedComponents phyloBranch1
+phyloCluster :: Map (Date,Date) [PhyloCluster]
+phyloCluster = phyloToClusters 2 (RelatedComponents $ RCParams $ WeightedLogJaccard $ WLJParams 0.05 10) phyloBranch1
 
 
-------------------------------------------------------------------------
--- | STEP 9 | -- Find the Branches
+----------------------------------
+-- | STEP 8 | -- Find the Branches
+----------------------------------
 
 
 phyloBranch1 :: Phylo
 phyloBranch1 = setPhyloBranches 1 phylo1_c
 
 
-------------------------------------------------------------------------
--- | STEP 8 | -- Link the PhyloGroups of level 1 through the Periods  
+--------------------------------------------------------------------
+-- | STEP 7 | -- Link the PhyloGroups of level 1 through the Periods
+--------------------------------------------------------------------
 
 
 phylo1_c :: Phylo
@@ -194,44 +185,36 @@ phylo1_p :: Phylo
 phylo1_p = interTempoMatching Ascendant 1 defaultWeightedLogJaccard phylo1_0_1
 
 
-------------------------------------------------------------------------
--- | STEP 7 | -- Build the coocurency Matrix of the Phylo 
-
-
-phyloCooc :: Map (Int, Int) Double
-phyloCooc = fisToCooc phyloFis phylo1_0_1
-
-
-------------------------------------------------------------------------
--- | STEP 6 | -- Build the level 1 of the Phylo 
+-----------------------------------------------
+-- | STEP 6 | -- Build the level 1 of the Phylo
+-----------------------------------------------
 
 
 phylo1_0_1 :: Phylo
-phylo1_0_1 = setLevelLinks (0,1) phylo1_1_0
+phylo1_0_1 = setLevelLinks (0,1) phylo1
 
 
-phylo1_1_0 :: Phylo
-phylo1_1_0 = setLevelLinks (1,0) phylo1
+-- phylo1_1_0 :: Phylo
+-- phylo1_1_0 = setLevelLinks (1,0) phylo1
 
 
 phylo1 :: Phylo
-phylo1 =  addPhyloLevel (1) phyloFis phylo
+phylo1 =  addPhyloLevel (1) phyloFis phylo'
 
 
-------------------------------------------------------------------------
+-------------------------------------------------------------------
 -- | STEP 5 | -- Create lists of Frequent Items Set and filter them
+-------------------------------------------------------------------
 
+phylo' :: Phylo 
+phylo' = phylo & phylo_fis .~ phyloFis
 
 phyloFis :: Map (Date, Date) [PhyloFis]
-phyloFis = filterFisBySupport False 1 (filterFisByNested (docsToFis phyloDocs))
-
+phyloFis = refineFis (docsToFis phyloDocs phylo) True 1 1
 
-------------------------------------------------------------------------
+----------------------------------------
 -- | STEP 2 | -- Init a Phylo of level 0
-
-
--- phylo' :: Phylo
--- phylo' = initPhylo 5 3 corpus actants groupNgramsWithTrees
+----------------------------------------
 
 
 phylo :: Phylo
@@ -239,35 +222,38 @@ phylo = addPhyloLevel 0 phyloDocs phyloBase
 
 
 phyloDocs :: Map (Date, Date) [Document]
-phyloDocs = corpusToDocs groupNgramsWithTrees corpus phyloBase
+phyloDocs = groupDocsByPeriod date (getPhyloPeriods phyloBase) docs
 
 
 ------------------------------------------------------------------------
 -- | STEP 1 | -- Init the Base of the Phylo from Periods and Foundations
+------------------------------------------------------------------------
 
 
-phyloBase :: Phylo
-phyloBase = initPhyloBase periods foundations
-
+phyloBase :: Phylo 
+phyloBase = toPhyloBase phyloQueryBuild phyloParam docs termList empty
 
-periods :: [(Date,Date)] 
-periods = initPeriods 5 3 
-        $ both fst (head corpus,last corpus)
+phyloParam :: PhyloParam
+phyloParam = (initPhyloParam (Just defaultPhyloVersion) (Just defaultSoftware) (Just phyloQueryBuild))
 
+docs :: [Document]
+docs = parseDocs foundationsRoots corpus
 
-foundations :: Vector Ngrams
-foundations = initFoundations actants
+foundationsRoots :: Vector Ngrams
+foundationsRoots = initFoundationsRoots (termListToNgrams termList)
 
 
-------------------------------------------------------------------------
+--------------------------------------------
 -- | STEP 0 | -- Let's start with an example
+--------------------------------------------
 
+termList :: TermList
+termList = map (\a -> ([toLower a],[])) actants
 
 actants :: [Ngrams]
 actants = [ "Cleopatre"   , "Ptolemee", "Ptolemee-XIII", "Ptolemee-XIV"
           , "Marc-Antoine", "Cesar"   , "Antoine"      , "Octave"  , "Rome"
           , "Alexandrie"  , "Auguste" , "Pompee"       , "Cassius" , "Brutus"]
 
-
 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")]
\ No newline at end of file
+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")]