https://github.com/mljs/tree-similarity
Tree similarity in Javascript
https://github.com/mljs/tree-similarity
Last synced: about 2 months ago
JSON representation
Tree similarity in Javascript
- Host: GitHub
- URL: https://github.com/mljs/tree-similarity
- Owner: mljs
- License: mit
- Created: 2015-07-15T11:20:19.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2024-10-17T12:00:47.000Z (8 months ago)
- Last Synced: 2025-04-16T04:45:56.645Z (2 months ago)
- Language: TypeScript
- Homepage:
- Size: 1.26 MB
- Stars: 8
- Watchers: 14
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# tree-similarity
[![NPM version][npm-image]][npm-url]
[![Test coverage][codecov-image]][codecov-url]
[![npm download][download-image]][download-url]
Compares two spectra using a tree similarity.
## Installation
`$ npm i ml-tree-similarity`
## Usage
```js
import { createTree, treeSimilarity } from 'ml-tree-similarity';
const a = {
x: [1, 2, 3, 4, 5, 6, 7],
y: [0.3, 0.7, 4, 0.3, 0.2, 5, 0.3],
};
const b = {
x: [1, 2, 3, 4, 5, 6, 7],
y: [0.3, 4, 0.7, 0.3, 5, 0.2, 0.3],
};
// create a tree
const options = { from: 1, to: 7 };
const aTree = createTree(a, options);
const bTree = createTree(b, options);
const ans = treeSimilarity(aTree, bTree, options);
```
## [API Documentation](https://mljs.github.io/tree-similarity/)
This algorithm was based in the following papers:
- [A new method for the comparison of 1H NMR predictors based on tree-similarity of spectra](https://doi.org/10.1186/1758-2946-6-9)
- [Fast and shift-insensitive similarity comparisons of NMR using a tree-representation of spectra](https://doi.org/10.1016/j.chemolab.2013.05.009)
## License
[MIT](./LICENSE)
[npm-image]: https://img.shields.io/npm/v/ml-tree-similarity.svg?style=flat-square
[npm-url]: https://npmjs.org/package/ml-tree-similarity
[codecov-image]: https://img.shields.io/codecov/c/github/mljs/tree-similarity.svg?style=flat-square
[codecov-url]: https://codecov.io/github/mljs/tree-similarity
[download-image]: https://img.shields.io/npm/dm/ml-tree-similarity.svg?style=flat-square
[download-url]: https://npmjs.org/package/ml-tree-similarity