R/TDIKeyData.R

In n0Trader/TDI: R Trading Data Interface

#' @title TDIKeyData (R6 class constructor)
#' @description 
#' Generic abstract base class for TDI result(s) key data.
#' The class is a data structure for instrument key data,
#' and should be implemented in the API implementation.
#' Using R6 classes for data structures enforce standardization.
#' @import R6
#' @export
TDIKeyData <- R6::R6Class("TDIKeyData", inherit = TDIResult,
  cloneable = FALSE, class = TRUE, # enabled S3 classes
  portable = TRUE, # enable inheritance across packages
  
  # Define data structure.
  public = list(
    #' @field sharesOutstanding Total number of shares.
    sharesOutstanding = NULL,
    #' @field currency Denomination currency.
    currency = NULL,
    #' @field price Current price.
    price = NULL,
    #' @field marketCap Shares total market capitalization.
    marketCap = NULL,
    #' @field ebitda EBITDA.
    ebitda = NULL,
    #' @field trailingEPS Trailing earnings per share.
    trailingEPS = NULL,
    #' @field forwardEPS Forward earnings per share.
    forwardEPS = NULL,
    #' @field trailingPE Trailing price/earnings.
    trailingPE = NULL,
    #' @field forwardPE Forward price/earnings.
    forwardPE = NULL,
    #' @field PEG Price/earnings to growth ratio.
    PEG = NA
  )
)