OHLC.create_candles
You're seeing just the function
create_candles
, go back to OHLC module for more information.
Link to this function
create_candles(trades, timeframe, opts \\ [])
Specs
create_candles(trades(), timeframe(), opts() | nil) :: {:ok, %{pair: binary() | atom(), timeframe: timeframe(), candles: candles()}} | {:error, atom()}
Function for generating candles from trades and timeframe provided.
Parameters:
trades
- A list containing all the trades. Trades must be chronologically arranged(ASC) by the timestamp field.timeframe
- Timeframe for the candles.opts
- Option values for the data proccessing.
Returns a tuple containing the metadata for the candles and a list of generated candles.