README.md

# DISCLAIMER

  Do note that this library is maintained to the best of its ability and all bugs will be addressed as soon as possible. That said, there is risk when using this library as formulas may be incorrect. By using this library
  you are acknowleding that the maintainers will not be liable for any issues that may arise from using the library while trading (such as any losses due to bugs)

# Taex

Taex is a library to provide easy access to many of the technical analysis calculations done while trading on open markets (stock, forex, etc). 

In order to use this library you can add

For the latest version (which could be broken), you can pull from GitHub:

`{:taex, git: "https://github.com/jhartwell/Taex.git"}`

If you want the stable version, then pull from hex by adding:

`{:taex, "~> 0.1.3"}`

to your deps in the mix.exs file

# Dependencies

Taex is dependents on the elixir statistics library https://github.com/msharp/elixir-statistics

# Testing

Currently the tests are being done by calculating the given indicator/oscillator in R using the TTR package (https://cran.r-project.org/web/packages/TTR/index.html) and then using the results from that to ensure that the data is accurate in Taex. This reduces the risk of calculating incorrectly by hand as well as prevents any logic that may be used in the actual calculation in Taex from touching the expected value of the indicator.

# Features

Currently supported features:

  * Moving Average
    * Exponential
    * Simple
    * Weighted

  * Indicators
    * MACD (Moving Average Convergence Divergence)
    * Aroon

  * Oscillators
    * Stochastic
    * Bollinger Bands