# wordcluster

> The simple cluster based on strings.

Latest version **1.0.0** (published 2018-08-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install wordcluster
pnpm add wordcluster
yarn add wordcluster
bun add wordcluster
```

## 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 | 2018-08-06 |
| First published | 2018-08-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | tinyjin |
| Maintainers | tinyjin |
| Keywords | node, word, cluster, nlp, natural, langugue |

## Links

- npm: https://www.npmjs.com/package/wordcluster
- Repository: https://github.com/tinyjin/WordCluster
- Issues: https://github.com/tinyjin/WordCluster/issues
- npm.io page: https://npm.io/package/wordcluster

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2018-08-06

## README

# WordCluster
The simple cluster based on strings.

## Intro
**WordCluster** is clustering string set using word frequency in string array.

## Install
```
npm install wordcluster --save
```

## Syntax
```
WordCluster.cluster(strings[, ignores[, isTrim[, minLen[, minCount]]]])
```
### Parameters
- strings : The value to be string array targeted for clustering.
- ignores : If something include in ignores, something can't be a cluster.
- isTrim : If this value on, cluster with trimed strings.
- minLen : Cluster string can't smaller than **minLen**.
- minCount : Cluster with a count smaller than **minCount** is can't be a cluster.

## Examples
```
const WordCluster = require('WordCluster');

const dataSet = [
  'Amazon Hotel 101',
  'Amazon Hotel 102',
  'Amazon Hotel 103',
  'Amazon Hotel 104',
  'Jin Hotel 101',
  'Jin Hotel 102'
];

const result = WordCluster.cluster(dataSet);

console.log(result);
/* result
{
  'Amazon Hotel 10': [
    'Amazon Hotel 101',
    'Amazon Hotel 102',
    'Amazon Hotel 103',
    'Amazon Hotel 104'
  ],
  'Jin Hotel 10': [
    'Jin Hotel 101',
    'Jin Hotel 102'
  ]
}
*/
```

## Authors
tinyjin - [Github](https:github.com/tinyjin), [Blog](http://jinui.kr)

## License
This project has MIT License.

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