R/getSectorETF.R

In alec25/smif.package: SMIF Risk Team Function Storage

#' Identify ETFs that correspond to a given sector
#'
#' Uses \code{getStockInfo.sector} and/or \code{cleanSector} to
#' retrieve uniform sector name for input. One of either
#' \code{ticker} or \code{sector} must be supplied.
#'
#' @note
#' \code{getSectorETF} is a wrapper of various sub-functions.
#' If both \code{ticker} and \code{sector} are supplied,
#' \code{sector} will take priority.
#' \code{getSectorETF.sector} is a helper function for
#' \code{getSectorETF} that works on it's own.
#'
#' @param ticker Character; string of a stock's ticker
#' @param sector Character; string of a sector
#'
#' @family data retrieval functions
#' @return Character; string of sector ETF's ticker
#' @export getSectorETF
#' @seealso \code{\link{getStockInfo.sector}}: to retrieve sector
#' that corresponds to input ticker. \code{\link{cleanSector}}: to
#' coerce sector into uniform name.
#'
#' @examples
#' getSectorETF(ticker = "NVDA")
#' getSectorETF(sector = "Consumer Non-Durables")
getSectorETF <- function(ticker, sector){
  if(missing(sector) && missing(ticker)){
    stop("One of arguments 'ticker' or 'sector' must be supplied.")
  }else if(missing(ticker)){
    return( getSectorETF.sector(sector = sector) )
  }else if(missing(sector)){
    newSector <- getStockInfo.sector(ticker)
    return( getSectorETF.sector(sector = newSector) )
  }
}
#' @rdname getSectorETF
#' @title Retrieve ETF for specified sector
#'
#' @export getSectorETF.sector
#' @keywords internal
#'
#' @examples
#' getSectorETF.sector("Telecom")
getSectorETF.sector <- function(sector){ #does this one really need it's own thing?
  # Clean input string
  if(getOption("verbose",F)){
    sector <- cleanSector(sector)
  }else{
    sector <- suppressMessages( cleanSector(sector) )
  }
  sectorData <- smif.package::smif_aa$sectors
  if(sector %in% sectorData$sectorName){
    return( sectorData[sectorData$sectorName == sector,]$sectorETF )
  }else if(grepl("Misc|Other", sector)){
    .showUSER("Sector is Miscellaneous/Other. Returning market ETF.")
    return("SPY")
  }
  stop(paste0("Sector ETF could not be found for ",sector))
}