Neglected Puppy Market

# npm

## simple-moving-avg

0.1.0 • Public • Published

# simple-moving-avg    Calculate the simple moving average for an array.

## Install

Install with npm:

## API

### sma

Calculate the simple moving average of a given array and using a subset of `n` elements. Note that elements that cannot be calculated because of not enough items in the subset will be set to 0

Example

Params

• `arr` {Array}: Array containing full set of items to calcualte
• `n` {Number}: Number of items in each subset to use
• `center` {Boolean}: Center around the item in the array. Defaults to `false`. See center for more details.
• `returns` {Array}: Array containing averaged values

### center

Calculate the simple moving average of a given array and using a subset of `n` elements. The subset is calculated around the current index using `{i - ceil(n/2) .. i + ceil(n/2)}`. This requires that `n` is odd to have a balanced number of items on either side of `i`. Note that elements that cannot be calculated because of not enough items in the subset will be set to 0

Example

Params

• `arr` {Array}: Array containing full set of items to calcualte
• `n` {Number}: Number of items in each subset to use
• `returns` {Array}: Array containing averaged values

### calc

The calculation function used for calculating the next simple moving average in a series of simple moving averages. This is used in the sma and center functions after calculating the average of the first subset. This reduces the amount of times that the total array needs to be sliced and also allows for using the calculation function outside of this library when streaming an array of values.

Example

Params

• `n` {Number}: Size of the subsets
• `precision` {Number}: Number of decimal places to use. Defaults to 0
• `returns` {Number}: Average from the calculation.

### Related projects

array-avg: Calculate the average of an array of numbers. | homepage

### Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for avice on opening issues, pull requests, and coding standards.

### Building docs

To generate the readme and API documentation with verb:

### Running tests

Install dev dependencies:

### Author

Brian Woodward

This file was generated by verb-generate-readme, v0.2.0, on November 02, 2016.

### Install

`npm i simple-moving-avg`

### Repository

github.com/doowb/simple-moving-avg

### Homepage

github.com/doowb/simple-moving-avg