R/get_ev_to_ebitda.R

In OliverHennhoefer/quant: Fundamentals Data for Stock Research

#' @title Get
#' Enterprise-Value-to-Earnings-before-Interest-and-Depreciation-Ratio
#'
#' @description Wrapper function for fetching data from
#' [gurufocus.com](https://www.gurufocus.com/term/ev2ebitda/AAPL/).
#'
#' @usage get_ev_to_ebitda(df)
#'
#' @param df data.frame. Data frame with column 'symbol' containing at least one
#' valid stock ticker symbol.
#'
#' @return Input data.frame supplemented by the company's available
#' **Enterprise Value to Earnings before Interest and Depreciation** data.
#' @export
#'
#' @examples
#' df <- data.frame('symbol' = 'AAPL')
#' res <- get_ev_to_ebitda(df)
#'
#' @details
#' The enterprise value to earnings before interest, taxes, depreciation, and
#' amortization ratio (EV/EBITDA) compares the value of a company—debt
#' included—to the company's cash earnings less non-cash expenses.

get_ev_to_ebitda <- function(df) {

  pfx <- 'ev2ebitda'
  url <- 'https://www.gurufocus.com/term/ev2ebitda/'
  xpath_tbl <- '//*[@id="target_def_historical_data"]/div[2]/div/table'
  xpath_txt <- '//*[@id="def_body_detail_height"]/font[1]'

  res <- suppressWarnings(scrape_key_fig(df, url, pfx, xpath_txt, xpath_tbl))

  return(res)
}