Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/galenseilis/conaction

A package for studying how things change together.
https://github.com/galenseilis/conaction

correlation correlation-analysis correlation-coefficient entropy-measures estimation information-theory math mathematical-functions mathematics multilinear-maps python python3 statistics statistics-library statistics-toolbox thesis-project transformation

Last synced: about 1 month ago
JSON representation

A package for studying how things change together.

Awesome Lists containing this project

README

        

# ConAction


Instantiations of the Trinity of Covariation



Open Source Love


Documentation Status


PyPI version


PyPI - Downloads


License


Code style: Black

## Project Description
The ConAction library provides mathematical functions that are inspired from the metaphor of the Trinity of Covariation as part of the MSc thesis of Galen Seilis.

Supervisory Committee Members

- Supervisor: [Dr. Edward Dobrowolski](https://www2.unbc.ca/people/dobrowolski-dr-edward) ([Department of Mathematics and Statistics, UNBC](https://www2.unbc.ca/math-statistics))
- Committee Member: [Dr. Brent Murray](https://web.unbc.ca/~murrayb/) ([Department of Biology, UNBC](https://www2.unbc.ca/biology))
- Committee Member: [Dr. Mohammad El Smaily](https://smaily.opened.ca/) ([Department of Mathematics and Statistics, UNBC](https://www2.unbc.ca/math-statistics))
- External Examiner: [Dr. Anne Condon](https://www.cs.ubc.ca/~condon/) ([Department of Computer Science](https://www.cs.ubc.ca/about))

The code in this repository is intended to support researchers analyzing multivariate data.

The thesis provides an extensive background reading for this package, and can be found at (link needed).

## Installation
ConAction is available through [PyPi](https://pypi.org/project/conaction/), and can be installed via `pip` using
```
pip install conaction
```
or
```
pip3 install conaction
```

## Example Usage

```python
from conaction import estimators
import numpy as np

X = np.random.normal(size=1000).reshape((100,10)) # Get a 100 x 10 data table

estimators.pearson_correlation(X) # Compute the 10-linear Pearson correlation coefficient
```

## Documentation

Build documentation locally:

```bash
cd /path/to/conaction/docs
make html
```

## Citation

```

@mastersthesis{seilisthesis2022,
author = "Galen Seilis",
title = "ConAction: Efficient Implementations and Applications of Functions Inspired by the Trinity of Covariation",
school = "University of Northern British Columbia",
year = "2022",
address = "3333 University Way, Prince George, British Columbia, V2N 4Z9, Canada",
month = "September",
doi = 10.24124/2022/59312,
url = https://doi.org/10.24124/2022/59312
}
```

![Star History Chart](https://api.star-history.com/svg?repos=galenseilis/ConAction&type=Date)