src/Gargantext/Core/Viz/AdaptativePhylo.hs

   1 {-|
   2 Module      : Gargantext.Core.Viz.AdaptativePhylo
   3 Description : Phylomemy definitions and types.
   4 Copyright   : (c) CNRS, 2017-Present
   5 License     : AGPL + CECILL v3
   6 Maintainer  : team@gargantext.org
   7 Stability   : experimental
   8 Portability : POSIX
   9
  10 Specifications of Phylomemy export format.
  11
  12 Phylomemy can be described as a Temporal Graph with different scale of
  13 granularity of group of ngrams (terms and multi-terms).
  14
  15 The main type is Phylo which is synonym of Phylomemy (only difference is
  16 the number of chars).
  17
  18 References:
  19 Chavalarias, D., Cointet, J.-P., 2013. Phylomemetic patterns
  20 in science evolution — the rise and fall of scientific fields. PloS
  21 one 8, e54847.
  22 -}
  23
  24 {-# LANGUAGE DeriveAnyClass   #-}
  25 {-# LANGUAGE TemplateHaskell   #-}
  26
  27 module Gargantext.Core.Viz.AdaptativePhylo where
  28
  29 import Data.Aeson
  30 import Data.Aeson.TH (deriveJSON)
  31 import Data.Text   (Text, pack)
  32 import Data.Vector (Vector)
  33 import Data.Map (Map)
  34
  35 import Gargantext.Core.Utils.Prefix (unPrefix)
  36 import Gargantext.Prelude
  37 import Gargantext.Core.Text.Context (TermList)
  38
  39 import GHC.Generics
  40 import GHC.IO (FilePath)
  41 import Control.DeepSeq (NFData)
  42 import Control.Lens (makeLenses)
  43
  44 import qualified Data.Text.Lazy as TextLazy
  45
  46
  47 ----------------
  48 -- | Config | --
  49 ----------------
  50
  51
  52 data CorpusParser =
  53       Wos {_wos_limit :: Int}
  54     | Csv {_csv_limit :: Int}
  55     deriving (Show,Generic,Eq)
  56
  57 data SeaElevation =
  58       Constante
  59       { _cons_start :: Double
  60       , _cons_step  :: Double }
  61     | Adaptative
  62       { _adap_granularity :: Double }
  63     deriving (Show,Generic,Eq)
  64
  65 data Proximity =
  66       WeightedLogJaccard
  67       { _wlj_sensibility   :: Double
  68 {-
  69       -- , _wlj_thresholdInit :: Double
  70       -- , _wlj_thresholdStep :: Double
  71       -- | max height for sea level in temporal matching
  72       -- , _wlj_elevation     :: Double
  73 -}
  74       }
  75     | Hamming
  76     deriving (Show,Generic,Eq)
  77
  78
  79 data SynchronyScope = SingleBranch | SiblingBranches | AllBranches deriving (Show,Generic,Eq)
  80
  81 data SynchronyStrategy = MergeRegularGroups | MergeAllGroups deriving (Show,Generic,Eq)
  82
  83 data Synchrony =
  84       ByProximityThreshold
  85       { _bpt_threshold :: Double
  86       , _bpt_sensibility :: Double
  87       , _bpt_scope :: SynchronyScope
  88       , _bpt_strategy :: SynchronyStrategy }
  89     | ByProximityDistribution
  90       { _bpd_sensibility :: Double
  91       , _bpd_strategy :: SynchronyStrategy }
  92     deriving (Show,Generic,Eq)
  93
  94
  95 data TimeUnit =
  96       Year
  97       { _year_period :: Int
  98       , _year_step   :: Int
  99       , _year_matchingFrame :: Int }
 100       deriving (Show,Generic,Eq)
 101
 102
 103 data Clique =
 104       Fis
 105       { _fis_support :: Int
 106       , _fis_size    :: Int }
 107     | MaxClique
 108       { _mcl_size :: Int }
 109       deriving (Show,Generic,Eq)
 110
 111
 112 data Quality =
 113      Quality { _qua_granularity :: Double
 114              , _qua_minBranch   :: Int }
 115       deriving (Show,Generic,Eq)
 116
 117
 118 data Config =
 119      Config { corpusPath     :: FilePath
 120             , listPath       :: FilePath
 121             , outputPath     :: FilePath
 122             , corpusParser   :: CorpusParser
 123             , phyloName      :: Text
 124             , phyloLevel     :: Int
 125             , phyloProximity :: Proximity
 126             , seaElevation   :: SeaElevation
 127             , phyloSynchrony :: Synchrony
 128             , phyloQuality   :: Quality
 129             , timeUnit       :: TimeUnit
 130             , clique         :: Clique
 131             , exportLabel    :: [PhyloLabel]
 132             , exportSort     :: Sort
 133             , exportFilter   :: [Filter]
 134             } deriving (Show,Generic,Eq)
 135
 136
 137 defaultConfig :: Config
 138 defaultConfig =
 139      Config { corpusPath     = ""
 140             , listPath       = ""
 141             , outputPath     = ""
 142             , corpusParser   = Csv 1000
 143             , phyloName      = pack "Default Phylo"
 144             , phyloLevel     = 2
 145             , phyloProximity = WeightedLogJaccard 10
 146             , seaElevation   = Constante 0.1 0.1
 147             , phyloSynchrony = ByProximityThreshold 0.5 10 SiblingBranches MergeAllGroups
 148             , phyloQuality   = Quality 100 1
 149             , timeUnit       = Year 3 1 5
 150             , clique         = MaxClique 0
 151             , exportLabel    = [BranchLabel MostEmergentTfIdf 2, GroupLabel MostEmergentInclusive 2]
 152             , exportSort     = ByHierarchy
 153             , exportFilter   = [ByBranchSize 2]
 154             }
 155
 156 instance FromJSON Config
 157 instance ToJSON Config
 158 instance FromJSON CorpusParser
 159 instance ToJSON CorpusParser
 160 instance FromJSON Proximity
 161 instance ToJSON Proximity
 162 instance FromJSON SeaElevation
 163 instance ToJSON SeaElevation
 164 instance FromJSON TimeUnit
 165 instance ToJSON TimeUnit
 166 instance FromJSON Clique
 167 instance ToJSON Clique
 168 instance FromJSON PhyloLabel
 169 instance ToJSON PhyloLabel
 170 instance FromJSON Tagger
 171 instance ToJSON Tagger
 172 instance FromJSON Sort
 173 instance ToJSON Sort
 174 instance FromJSON Order
 175 instance ToJSON Order
 176 instance FromJSON Filter
 177 instance ToJSON Filter
 178 instance FromJSON SynchronyScope
 179 instance ToJSON SynchronyScope
 180 instance FromJSON SynchronyStrategy
 181 instance ToJSON SynchronyStrategy
 182 instance FromJSON Synchrony
 183 instance ToJSON Synchrony
 184 instance FromJSON Quality
 185 instance ToJSON Quality
 186
 187
 188 -- | Software parameters
 189 data Software =
 190      Software { _software_name    :: Text
 191               , _software_version :: Text
 192      } deriving (Generic, Show, Eq)
 193
 194 defaultSoftware :: Software
 195 defaultSoftware =
 196       Software { _software_name    = pack "Gargantext"
 197                , _software_version = pack "v4" }
 198
 199
 200 -- | Global parameters of a Phylo
 201 data PhyloParam =
 202      PhyloParam { _phyloParam_version  :: Text
 203                 , _phyloParam_software :: Software
 204                 , _phyloParam_config   :: Config
 205      } deriving (Generic, Show, Eq)
 206
 207 defaultPhyloParam :: PhyloParam
 208 defaultPhyloParam =
 209       PhyloParam { _phyloParam_version  = pack "v2.adaptative"
 210                  , _phyloParam_software = defaultSoftware
 211                  , _phyloParam_config   = defaultConfig }
 212
 213
 214 ------------------
 215 -- | Document | --
 216 ------------------
 217
 218
 219 -- | Date : a simple Integer
 220 type Date = Int
 221
 222 -- | Ngrams : a contiguous sequence of n terms
 223 type Ngrams = Text
 224
 225 -- | Document : a piece of Text linked to a Date
 226 data Document = Document
 227       { date :: Date
 228       , text :: [Ngrams]
 229       } deriving (Eq,Show,Generic,NFData)
 230
 231
 232 --------------------
 233 -- | Foundation | --
 234 --------------------
 235
 236
 237 -- | The Foundations of a Phylo created from a given TermList
 238 data PhyloFoundations = PhyloFoundations
 239       { _foundations_roots   :: !(Vector Ngrams)
 240       , _foundations_mapList :: TermList
 241       } deriving (Generic, Show, Eq)
 242
 243
 244 ---------------------------
 245 -- | Coocurency Matrix | --
 246 ---------------------------
 247
 248
 249 -- | Cooc : a coocurency matrix between two ngrams
 250 type Cooc =  Map (Int,Int) Double
 251
 252
 253 -------------------
 254 -- | Phylomemy | --
 255 -------------------
 256
 257
 258 -- | Phylo datatype of a phylomemy
 259 --  foundations : the foundations of the phylo
 260 --  timeCooc : a Map of coocurency by minimal unit of time (ex: by year)
 261 --  timeDocs : a Map with the numbers of docs by minimal unit of time (ex: by year)
 262 --  param : the parameters of the phylomemy (with the user's configuration)
 263 --  periods : the temporal steps of a phylomemy
 264 data Phylo =
 265      Phylo { _phylo_foundations  :: PhyloFoundations
 266            , _phylo_timeCooc     :: !(Map Date Cooc)
 267            , _phylo_timeDocs     :: !(Map Date Double)
 268            , _phylo_termFreq     :: !(Map Int Double)
 269            , _phylo_lastTermFreq :: !(Map Int Double)
 270            , _phylo_horizon      :: !(Map (PhyloGroupId,PhyloGroupId) Double)
 271            , _phylo_groupsProxi  :: !(Map (PhyloGroupId,PhyloGroupId) Double)
 272            , _phylo_param        :: PhyloParam
 273            , _phylo_periods      :: Map PhyloPeriodId PhyloPeriod
 274            }
 275            deriving (Generic, Show, Eq)
 276
 277
 278 -- | PhyloPeriodId : the id of a given period
 279 type PhyloPeriodId = (Date,Date)
 280
 281 -- | PhyloPeriod : steps of a phylomemy on a temporal axis
 282 --  id: tuple (start date, end date) of the temporal step of the phylomemy
 283 --  levels: levels of granularity
 284 data PhyloPeriod =
 285      PhyloPeriod { _phylo_periodPeriod :: (Date,Date)
 286                  , _phylo_periodLevels :: Map PhyloLevelId PhyloLevel
 287                  } deriving (Generic, Show, Eq)
 288
 289
 290 -- | Level : a level of clustering
 291 type Level = Int
 292
 293 -- | PhyloLevelId : the id of a level of clustering in a given period
 294 type PhyloLevelId  = (PhyloPeriodId,Level)
 295
 296 -- | PhyloLevel : levels of phylomemy on a synchronic axis
 297 -- Levels description:
 298 -- Level 0: The foundations and the base of the phylo
 299 -- Level 1: First level of clustering (the Fis)
 300 -- Level [2..N]: Nth level of synchronic clustering (cluster of Fis)
 301 data PhyloLevel =
 302      PhyloLevel { _phylo_levelPeriod :: (Date,Date)
 303                 , _phylo_levelLevel  :: Level
 304                 , _phylo_levelGroups :: Map PhyloGroupId PhyloGroup
 305                 }
 306                 deriving (Generic, Show, Eq)
 307
 308
 309 type PhyloGroupId  = (PhyloLevelId, Int)
 310
 311 -- | BranchId : (a level, a sequence of branch index)
 312 -- the sequence is a path of heritage from the most to the less specific branch
 313 type PhyloBranchId = (Level, [Int])
 314
 315 -- | PhyloGroup : group of ngrams at each level and period
 316 data PhyloGroup =
 317       PhyloGroup { _phylo_groupPeriod   :: (Date,Date)
 318                  , _phylo_groupLevel    :: Level
 319                  , _phylo_groupIndex    :: Int
 320                  , _phylo_groupLabel    :: Text
 321                  , _phylo_groupSupport  :: Support
 322                  , _phylo_groupNgrams   :: [Int]
 323                  , _phylo_groupCooc     :: !(Cooc)
 324                  , _phylo_groupBranchId :: PhyloBranchId
 325                  , _phylo_groupMeta     :: Map Text [Double]
 326                  , _phylo_groupLevelParents  :: [Pointer]
 327                  , _phylo_groupLevelChilds   :: [Pointer]
 328                  , _phylo_groupPeriodParents :: [Pointer]
 329                  , _phylo_groupPeriodChilds  :: [Pointer]
 330                  , _phylo_groupAncestors     :: [Pointer]
 331                  }
 332                  deriving (Generic, Show, Eq, NFData)
 333
 334 -- | Weight : A generic mesure that can be associated with an Id
 335 type Weight = Double
 336
 337 -- | Pointer : A weighted pointer to a given PhyloGroup
 338 type Pointer = (PhyloGroupId, Weight)
 339
 340 data Filiation = ToParents | ToChilds deriving (Generic, Show)
 341 data PointerType = TemporalPointer | LevelPointer deriving (Generic, Show)
 342
 343
 344 ----------------------
 345 -- | Phylo Clique | --
 346 ----------------------
 347
 348 -- | Support : Number of Documents where a Clique occurs
 349 type Support  = Int
 350
 351 data PhyloClique = PhyloClique
 352   { _phyloClique_nodes   :: [Int]
 353   , _phyloClique_support :: Support
 354   , _phyloClique_period  :: (Date,Date)
 355   } deriving (Generic,NFData,Show,Eq)
 356
 357 ----------------
 358 -- | Export | --
 359 ----------------
 360
 361 type DotId = TextLazy.Text
 362
 363 data EdgeType = GroupToGroup | BranchToGroup | BranchToBranch | GroupToAncestor | PeriodToPeriod deriving (Show,Generic,Eq)
 364
 365 data Filter = ByBranchSize { _branch_size :: Double } deriving (Show,Generic,Eq)
 366
 367 data Order = Asc | Desc deriving (Show,Generic,Eq)
 368
 369 data Sort = ByBirthDate { _sort_order :: Order } | ByHierarchy deriving (Show,Generic,Eq)
 370
 371 data Tagger = MostInclusive | MostEmergentInclusive | MostEmergentTfIdf deriving (Show,Generic,Eq)
 372
 373 data PhyloLabel =
 374       BranchLabel
 375       { _branch_labelTagger :: Tagger
 376       , _branch_labelSize   :: Int }
 377     | GroupLabel
 378       { _group_labelTagger  :: Tagger
 379       , _group_labelSize    :: Int }
 380     deriving (Show,Generic,Eq)
 381
 382 data PhyloBranch =
 383       PhyloBranch
 384       { _branch_id :: PhyloBranchId
 385       , _branch_canonId  :: [Int]
 386       , _branch_seaLevel :: [Double]
 387       , _branch_x        :: Double
 388       , _branch_y        :: Double
 389       , _branch_w        :: Double
 390       , _branch_t        :: Double
 391       , _branch_label    :: Text
 392       , _branch_meta     :: Map Text [Double]
 393       } deriving (Generic, Show, Eq)
 394
 395 data PhyloExport =
 396       PhyloExport
 397       { _export_groups    :: [PhyloGroup]
 398       , _export_branches  :: [PhyloBranch]
 399       } deriving (Generic, Show)
 400
 401 ----------------
 402 -- | Lenses | --
 403 ----------------
 404
 405 makeLenses ''Config
 406 makeLenses ''Proximity
 407 makeLenses ''SeaElevation
 408 makeLenses ''Quality
 409 makeLenses ''Clique
 410 makeLenses ''PhyloLabel
 411 makeLenses ''TimeUnit
 412 makeLenses ''PhyloFoundations
 413 makeLenses ''PhyloClique
 414 makeLenses ''Phylo
 415 makeLenses ''PhyloPeriod
 416 makeLenses ''PhyloLevel
 417 makeLenses ''PhyloGroup
 418 makeLenses ''PhyloParam
 419 makeLenses ''PhyloExport
 420 makeLenses ''PhyloBranch
 421
 422 ------------------------
 423 -- | JSON instances | --
 424 ------------------------
 425
 426
 427 $(deriveJSON (unPrefix "_foundations_"  ) ''PhyloFoundations)