Class: TechnicalAnalysis::Cr

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

Overview

Cumulative Return

Class Method Summary collapse

Methods inherited from Indicator

find, roster

Class Method Details

.calculate(data, price_key: :value) ⇒ Array<CrValue>

Calculates the cumulative return (CR) for the data over the given period www.investopedia.com/terms/c/cumulativereturn.asp

Parameters:

  • data (Array) —

    Array of hashes with keys (:date_time, :value)

  • price_key (Symbol) (defaults to: :value) —

    The hash key for the price data. Default :value

Returns:

  • (Array<CrValue>) —

    An array of CrValue instances



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/technical_analysis/indicators/cr.rb', line 52

def self.calculate(data, price_key: :value)
  price_key = price_key.to_sym
  Validation.validate_numeric_data(data, price_key)
  Validation.validate_length(data, min_data_size({}))
  Validation.validate_date_time_key(data)

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

  output = []
  start_price = data.first[price_key] 

  data.each do |v|
    output << CrValue.new(
      date_time: v[:date_time],
      cr: ((v[price_key] - start_price) / start_price)
    )
  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/cr.rb', line 15

def self.indicator_name
  "Cumulative Return"
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/cr.rb', line 8

def self.indicator_symbol
  "cr"
end

.min_data_size(**params) ⇒ 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/cr.rb', line 41

def self.min_data_size(**params)
  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/cr.rb', line 22

def self.valid_options
  %i(price_key)
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/cr.rb', line 31

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