README.md

#  Statistics
 
[![Build Status](https://travis-ci.org/msharp/elixir-statistics.svg?branch=master)](https://travis-ci.org/msharp/elixir-statistics)

Statistics functions for [Elixir](https://github.com/elixir-lang/elixir).

## Usage 

Add Statistics as a dependency in your `mix.exs` file to install from [hex.pm](https://hex.pm).

```elixir
def deps do
  [ 
    { :statistics, "~> 0.1.6"} 
  ]
end
```
  
After you are done, run `mix deps.get` in your shell to fetch and compile Statistics. 

To try it out, start an interactive Elixir shell with `iex -S mix`.

```iex
iex> alias Statistics, as: S
nil
iex> S.Descriptive.median([1,2,3])
2
iex> S.Descriptive.variance([1,2,3,4])
1.25
```

## Roadmap

This library is currently only descriptive statistics. But I'm planning to add common statistical tests and distributions.

## Contributing

Happy to accept pull requests. Please create a topic branch with tests.

## License

Apache 2