R/sharpe.R

In stocks: Stock Market Analysis

#' Sharpe Ratio
#' 
#' Calculates Sharpe ratio from vector of gains or prices. The formula is: 
#' \code{(mean(gains) - rf) / sd(gains)}, where \code{rf} is some risk-free rate 
#' of return.
#' 
#' 
#' @inheritParams metrics
#' @param rf Numeric value.
#' 
#' 
#' @return
#' Numeric value.
#' 
#' 
#' @examples
#' # Simulate daily gains over a 5-year period
#' set.seed(123)
#' stock.gains <- rnorm(252 * 5, 0.0005, 0.01)
#' 
#' # Calculate Sharpe ratio using risk-free return of 0
#' sharpe(stock.gains)
#' 
#' 
#' @export
sharpe <- function(gains = NULL,
                   prices = NULL,
                   rf = 0) {
  
  # Convert from prices to gains if necessary
  if (! is.null(prices)) {
    gains <- prices_gains(prices)
  }
    
  # Calculate and return Sharpe ratio
  if (is.vector(gains)) {
    sharpe.ratio <- (mean(gains) - rf) / sd(gains)
  } else {
    means <- apply(gains, 2, mean)
    sds <- apply(gains, 2, sd)
    sharpe.ratio <- (means - rf) / sds
  }
  return(sharpe.ratio)
  
}