Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/doowb/sma
Calculate the simple moving average of an array.
https://github.com/doowb/sma
array array-average array-avg average average-array avg avg-array floating floating-average javascript moving-average nodejs rolling rolling-average simple-floating-average simple-moving-average simple-rolling-average
Last synced: 2 months ago
JSON representation
Calculate the simple moving average of an array.
- Host: GitHub
- URL: https://github.com/doowb/sma
- Owner: doowb
- License: mit
- Created: 2017-04-10T16:33:34.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-12T22:22:19.000Z (over 6 years ago)
- Last Synced: 2024-10-10T12:18:50.062Z (3 months ago)
- Topics: array, array-average, array-avg, average, average-array, avg, avg-array, floating, floating-average, javascript, moving-average, nodejs, rolling, rolling-average, simple-floating-average, simple-moving-average, simple-rolling-average
- Language: JavaScript
- Homepage: https://doowb.com
- Size: 12.7 KB
- Stars: 54
- Watchers: 2
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# sma [](https://www.npmjs.com/package/sma) [](https://npmjs.org/package/sma) [](https://npmjs.org/package/sma) [](https://travis-ci.org/doowb/sma)
> Calculate the simple moving average of an array.
Please consider following this project's author, [Brian Woodward](https://github.com/doowb), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save sma
```
## Usage
```js
var sma = require('sma');
```
## API
### [sma](index.js#L24)
Calculate the simple moving average of an array. A new array is returned with the average of each range of elements. A range will only be calculated when it contains enough elements to fill the range.
**Params**
* `arr` **{Array}**: Array of numbers to calculate.
* `range` **{Number}**: Size of the window to use to when calculating the average for each range. Defaults to array length.
* `format` **{Function}**: Custom format function called on each calculated average. Defaults to `n.toFixed(2)`.
* `returns` **{Array}**: Resulting array of averages.
**Example**
```js
console.log(sma([1, 2, 3, 4, 5, 6, 7, 8, 9], 4));
//=> [ '2.50', '3.50', '4.50', '5.50', '6.50', '7.50' ]
//=> │ │ │ │ │ └─(6+7+8+9)/4
//=> │ │ │ │ └─(5+6+7+8)/4
//=> │ │ │ └─(4+5+6+7)/4
//=> │ │ └─(3+4+5+6)/4
//=> │ └─(2+3+4+5)/4
//=> └─(1+2+3+4)/4
```
## Attribution
Thanks to [@jonschlinkert](https://github.com/jonschlinkert) for simplifying the algorithm. For more moving average modules checkout the [related projects](#related-projects) below.
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Please read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Related projects
You might also be interested in these projects:
[exponential-moving-average](https://www.npmjs.com/package/exponential-moving-average): Calculate an exponential moving average from an array of numbers. | [homepage](https://github.com/jonschlinkert/exponential-moving-average "Calculate an exponential moving average from an array of numbers.")
### Author
**Brian Woodward**
* [GitHub Profile](https://github.com/doowb)
* [Twitter Profile](https://twitter.com/doowb)
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
### License
Copyright © 2018, [Brian Woodward](https://doowb.com).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on September 12, 2018._