Class: TechnicalAnalysis::Atr

Inherits:
Indicator show all
Defined in:
lib/technical_analysis/indicators/atr.rb

Overview

Average True Range

Class Method Summary collapse

Methods inherited from Indicator

find, roster

Class Method Details

.calculate(data, period: 14) ⇒ Array<AtrValue>

Calculates the average true range (ATR) for the data over the given period en.wikipedia.org/wiki/Average_true_range

Parameters:

  • data (Array) —

    Array of hashes with keys (:date_time, :high, :low, :close)

  • period (Integer) (defaults to: 14) —

    The given period to calculate the ATR

Returns:

  • (Array<AtrValue>) —

    An array of AtrValue instances



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/technical_analysis/indicators/atr.rb', line 52

def self.calculate(data, period: 14)
  period = period.to_i
  Validation.validate_numeric_data(data, :high, :low, :close)
  Validation.validate_length(data, min_data_size(period: period))
  Validation.validate_date_time_key(data)

  data = data.sort_by { |row| row[:date_time] }

  output = []
  period_values = []
  prev_price = data.shift

  data.each do |v|
    tr = StockCalculation.true_range(v[:high], v[:low], prev_price[:close])

    period_values << tr

    if period_values.size == period
      if output.empty?
        atr = ArrayHelper.average(period_values)
      else
        atr = (output.last.atr * (period - 1.0) + tr) / period.to_f
      end

      output << AtrValue.new(date_time: v[:date_time], atr: atr)

      period_values.shift
    end

    prev_price = v
  end

  output.sort_by(&:date_time).reverse
end

.indicator_name ⇒ String

Returns the name of the technical indicator

Returns:

  • (String) —

    A string of the name of the technical indicator



15
16
17
 
# File 'lib/technical_analysis/indicators/atr.rb', line 15

def self.indicator_name
  "Average True Range"
end

.indicator_symbol ⇒ String

Returns the symbol of the technical indicator

Returns:

  • (String) —

    A string of the symbol of the technical indicator



8
9
10
 
# File 'lib/technical_analysis/indicators/atr.rb', line 8

def self.indicator_symbol
  "atr"
end

.min_data_size(period: 14) ⇒ Integer

Calculates the minimum number of observations needed to calculate the technical indicator

Parameters:

  • options (Hash) —

    The options for the technical indicator

Returns:

  • (Integer) —

    Returns the minimum number of observations needed to calculate the technical indicator based on the options provided



41
42
43
 
# File 'lib/technical_analysis/indicators/atr.rb', line 41

def self.min_data_size(period: 14)
  period.to_i + 1
end

.valid_options ⇒ Array

Returns an array of valid keys for options for this technical indicator

Returns:

  • (Array) —

    An array of keys as symbols for valid options for this technical indicator



22
23
24
 
# File 'lib/technical_analysis/indicators/atr.rb', line 22

def self.valid_options
  %i(period)
end

.validate_options(options) ⇒ Boolean

Validates the provided options for this technical indicator

Parameters:

  • options (Hash) —

    The options for the technical indicator to be validated

Returns:

  • (Boolean) —

    Returns true if options are valid or raises a ValidationError if they’re not



31
32
33
 
# File 'lib/technical_analysis/indicators/atr.rb', line 31

def self.validate_options(options)
  Validation.validate_options(options, valid_options)
end