# pearson-pair

> Simple JavaScript Library to calculate pair of highest and lowest correlation integer arrays.

Latest version **1.0.0** (published 2021-04-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install pearson-pair
pnpm add pearson-pair
yarn add pearson-pair
bun add pearson-pair
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-04-11 |
| First published | 2021-04-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Tejas Chendekar |
| Maintainers | tejas7777 |
| Keywords | pearson, correlation, correlation-pairs, pairs |

## Links

- npm: https://www.npmjs.com/package/pearson-pair
- Repository: https://github.com/tejas7777/pearson-pair
- Homepage: https://github.com/tejas7777/pearson-pair#readme
- Issues: https://github.com/tejas7777/pearson-pair/issues
- npm.io page: https://npm.io/package/pearson-pair

## Recent versions

- 1.0.0 (latest) — 2021-04-11

## README

# Pearson Pairs
JavaScript package to form pairs of highest and lowest correlation arrays.

## Install

### To install globally
```
npm pearson-pair
```
### To install locally
```
npm pearson-pair
```

## Import

```JavaScript
const PearsonPair = require('PearsonPair')
```

## Use

### Create a pearson-pair object

```JavaScript
pcor = PearsonPair([[1,2,3],[2,2,4],[3,2,4],[3,4,7]])
```

### Find the closest pair

```JavaScript
pcor.findClosestPair()
```

### Find the most distant pair

```JavaScript
pcor.findDistantPair()
```

### Get the correlation matrix
```JavaScript
pcor.getCorrelationMatrix()
```
### Get the highest correlation along with the pair indices
```JavaScript
pcor.getHighest()
```

### Get the lowest correlation along with the pair indices
```JavaScript
pcor.getLowest()
```

#### License: MIT

---
_Source: https://npm.io/package/pearson-pair · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._