gains_rate: Calculate Growth Rate from Sequence of Gains
In vandomed/stocks: Stock Market Analysis

Description Usage Arguments Value Examples

The formula is simply: prod(gains + 1) - 1. If units.out is specified, then it converts to x-unit growth rate.

1	gains_rate(gains, units.out = NULL)

`gains`	Data frame with one column of gains for each investment (can be a numeric vector if there is only one).
`units.out`	Numeric value specifying the number of units for growth rate calculation, if you want something other than total growth. For annualized growth rate, set to 252 if `gains` has daily gains, 12 if `gains` has monthly gains, etc.

Numeric vector.

# Create vector of daily gains for a hypothetical stock
daily.gains <- c(-0.02, -0.01, 0.01, 0.02, 0.01)

# Overall growth is 0.95%
gains_rate(daily.gains)

# Average daily growth is 0.19%
gains_rate(daily.gains, 1)

# Corresponds to 61.0% annual growth
gains_rate(daily.gains, 252)