https://github.com/stscl/infocausality

Information-Theoretic Measure of Causality
https://github.com/stscl/infocausality

causal-discovery causality entropy-measures information-flow temporal-causality time-series-analysis

Last synced: 3 months ago
JSON representation

Information-Theoretic Measure of Causality

• Host: GitHub
• URL: https://github.com/stscl/infocausality
• Owner: stscl
• Created: 2025-10-07T15:48:13.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2026-03-21T03:58:06.000Z (3 months ago)
• Last Synced: 2026-03-28T00:39:35.157Z (3 months ago)
• Topics: causal-discovery, causality, entropy-measures, information-flow, temporal-causality, time-series-analysis
• Language: C++
• Homepage: https://stscl.github.io/infocausality/
• Size: 2.7 MB
• Stars: 5
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md

Awesome Lists containing this project

README

          
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "##",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# infocausality

[![CRAN](https://www.r-pkg.org/badges/version/infocausality)](https://CRAN.R-project.org/package=infocausality)

[![CRAN Release](https://www.r-pkg.org/badges/last-release/infocausality)](https://CRAN.R-project.org/package=infocausality)

[![CRAN Checks](https://badges.cranchecks.info/worst/infocausality.svg)](https://cran.r-project.org/web/checks/check_results_infocausality.html)

[![Downloads_all](https://badgen.net/cran/dt/infocausality?color=orange)](https://CRAN.R-project.org/package=infocausality)

[![Downloads_month](https://cranlogs.r-pkg.org/badges/infocausality)](https://CRAN.R-project.org/package=infocausality)

[![License](https://img.shields.io/badge/license-GPL--3-brightgreen.svg?style=flat)](http://www.gnu.org/licenses/gpl-3.0.html)

[![Lifecycle: superseded](https://lifecycle.r-lib.org/articles/figures/lifecycle-superseded.svg)](https://lifecycle.r-lib.org/articles/stages.html#superseded)

[![R-CMD-check](https://github.com/stscl/infocausality/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/stscl/infocausality/actions/workflows/R-CMD-check.yaml)

[![R-universe](https://stscl.r-universe.dev/badges/infocausality?color=cyan)](https://stscl.r-universe.dev/infocausality)



*Information-Theoretic Measure of Causality*

`infocausality` is an R package for information-theoretic causal analysis.  

It quantifies temporal and spatial causality through information flow, and decomposes it into unique, redundant, and synergistic components. The package provides native support for `data.frame`, `sf`, and `SpatRaster` objects, offering a unified interface for both time-series and spatial cross-sectional causal analysis.

> *Refer to the package documentation  for more detailed information.*

> ⚠️ **Note**: The SURD (Synergistic-Unique-Redundant Decomposition) core computations in `infocausality` are executed via Python bindings. A pure C++ implementation with improved performance and easier deployment has been developed in the [`infoxtr`](https://github.com/stscl/infoxtr) package. For new projects, we recommend using `infoxtr` as a drop-in replacement.

## Installation

- Install from [CRAN](https://CRAN.R-project.org/package=infocausality) with:

``` r

install.packages("infocausality", dep = TRUE)

```

- Install binary version from [R-universe](https://stscl.r-universe.dev/infocausality) with:

``` r

install.packages("infocausality",

                 repos = c("https://stscl.r-universe.dev",

                           "https://cloud.r-project.org"),

                 dep = TRUE)

```

- Install from source code on [GitHub](https://github.com/stscl/infocausality) with:

```r

if (!requireNamespace("devtools")) {

    install.packages("devtools")

}

devtools::install_github("stscl/infocausality",

                         build_vignettes = TRUE,

                         dep = TRUE)

```