Conditional mutual information (#160)

* Update version to gain access to `conditional_mutualinfo`` * Reexport `conditional_mutualinfo` * Docs for `conditional_mutualinfo`
JuliaDynamics · May 23, 2022 · e1de394 · e1de394 · kahaaga · May 23, 2022
1 parent 934cfec
commit e1de394
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 4 deletions.
diff --git a/Project.toml b/Project.toml
@@ -2,7 +2,7 @@ name = "CausalityTools"
 uuid = "5520caf5-2dd7-5c5d-bfcb-a00e56ac49f7"
 authors = ["Kristian Agasøster Haaga <[email protected]>", "Tor Einar Møller <[email protected]>", "George Datseris <[email protected]>"]
 repo = "https://github.com/kahaaga/CausalityTools.jl.git"
-version = "1.3.0"
+version = "1.4.0"
 
 [deps]
 ChaosTools = "608a59af-f2a3-5ad4-90b4-758bdf3122a7"
@@ -44,7 +44,7 @@ SimpleDiffEq = "^1"
 StaticArrays = "^1"
 StatsBase = "^0.33"
 TimeseriesSurrogates = "^1.2, 2"
-TransferEntropy = "^1.7"
+TransferEntropy = "^1.8"
 Wavelets = "0.9"
 julia = "^1.6"
 

diff --git a/changelog.md b/changelog.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.4.0
+
+### New methods
+
+- Added [`conditional_mutualinfo`](@ref).
+
 ## 1.3.0
 
 ### Example systems

diff --git a/docs/make.jl b/docs/make.jl
@@ -45,6 +45,7 @@ PAGES = [
     ],
     "Information/entropy based" => [
         "mutualinfo.md",
+        "conditional_mutualinfo.md",
         "TransferEntropy.md",
         "predictive_asymmetry.md",
         "generalized_entropy.md",

diff --git a/docs/src/conditional_mutualinfo.md b/docs/src/conditional_mutualinfo.md
@@ -0,0 +1,5 @@
+# Conditional mutual information
+
+```@docs
+conditional_mutualinfo
+```
diff --git a/src/CausalityTools.jl b/src/CausalityTools.jl
@@ -5,8 +5,8 @@ module CausalityTools
     export trajectory, DiscreteDynamicalSystem, ContinuousDynamicalSystem, Dataset
 
     import TransferEntropy
-    import TransferEntropy: transferentropy, mutualinfo, Hilbert
-    export transferentropy, mutualinfo, Hilbert
+    import TransferEntropy: transferentropy, mutualinfo, conditional_mutualinfo, Hilbert
+    export transferentropy, mutualinfo, conditional_mutualinfo, Hilbert
     @reexport using Entropies
     @reexport using TransferEntropy
     @reexport using TimeseriesSurrogates