R/generics.r

In bautheac/pullit: Pulling financial data from Bloomberg made easy

# info ####

## DataInfo ####
#' Accesses the \code{info} slot of S4 objects of class \linkS4class{DataInfo}
#'   (\href{https://github.com/bautheac/pullit/}{\pkg{pullit}}).
#'
#'
#' @description Access method for the \code{info} slot of S4 objects of class
#'   \linkS4class{DataInfo} (\href{https://github.com/bautheac/pullit/}{\pkg{pullit}}).
#'
#'
#' @param object an S4 object of class \linkS4class{DataInfo} or childs.
#'
#'
#' @return A \link[tibble]{tibble} showing qualitative data contained in the
#'   \code{object} provided.
#'
#'
#' @docType methods
#'
#' @rdname get_info-methods
#'
#'
#' @importFrom tibble tibble
#'
#'
#' @export
setGeneric("get_info", function(object) standardGeneric("get_info"))


# tickers ####

## DataHistorical ####
#' Accesses \code{tickers} slot of various S4 objects from
#'   \href{https://github.com/bautheac/pullit/}{\pkg{pullit}}.
#'
#'
#' @description Access method for the \code{tickers} slot of various S4 objects from the
#'   \href{https://github.com/bautheac/pullit/}{\pkg{pullit}} package.
#'
#'
#' @param object an S4 object of class \linkS4class{DataHistorical} or childs.
#'
#'
#' @return A \link[data.table]{data.table} showing the Bloomberg tickers for which the
#'   \code{object} provided contains data.
#'
#'
#' @docType methods
#'
#' @rdname get_tickers-methods
#'
#'
#' @importClassesFrom data.table data.table
#'
#'
#' @export
setGeneric("get_tickers", function(object) standardGeneric("get_tickers"))

## FuturesMarket ####
#' Accesses the \code{active_contract_tickers} slot of S4 objects of class
#'   \linkS4class{FuturesMarket} (\href{https://github.com/bautheac/pullit/}{\pkg{pullit}}).
#'
#' @description Access method for the \code{active_contract_tickers} slot of
#'   \linkS4class{FuturesMarket} S4 objects from the
#'   \href{https://github.com/bautheac/pullit/}{\pkg{pullit}} package.
#'
#'
#' @param object an S4 object of class \linkS4class{FuturesMarket} or childs.
#'
#'
#' @return A \link[data.table]{data.table} showing the futures active contract
#'   Bloomberg tickers for which the \code{object} provided contains data.
#'
#'
#' @docType methods
#'
#' @rdname get_active_contract_tickers-methods
#'
#'
#' @importClassesFrom data.table data.table
#'
#'
#' @export
setGeneric("get_active_contract_tickers", function(object) standardGeneric("get_active_contract_tickers"))

## FuturesTS ####
#' Accesses the \code{term_structure_tickers} slot of S4 objects of class
#'   \linkS4class{FuturesTS} (\href{https://github.com/bautheac/pullit/}{\pkg{pullit}}).
#'
#'
#' @description Access method for the \code{term_structure_tickers} slot of
#'   \linkS4class{FuturesTS} S4 objects from the
#'   \href{https://github.com/bautheac/pullit/}{\pkg{pullit}} package.
#'
#'
#' @param object an S4 object of class \linkS4class{FuturesTS}.
#'
#'
#' @return A \link[data.table]{data.table} showing the futures term structure
#'   Bloomberg tickers for which the \code{object} provided contains data.
#'
#'
#' @docType methods
#'
#' @rdname get_term_structure_tickers-methods
#'
#'
#' @importClassesFrom data.table data.table
#'
#'
#' @export
setGeneric("get_term_structure_tickers", function(object) standardGeneric("get_term_structure_tickers"))

## FuturesCFTC ####
#' Accesses the \code{cftc_tickers} slot S4 objects of class \linkS4class{FuturesCFTC}
#'   (\href{https://github.com/bautheac/pullit/}{\pkg{pullit}}).
#'
#'
#' @description Access method for the \code{cftc_tickers} slot of \linkS4class{FuturesCFTC}
#'   S4 objects from the \href{https://github.com/bautheac/pullit/}{\pkg{pullit}} package.
#'
#'
#' @param object an S4 object of class \linkS4class{FuturesCFTC}.
#'
#'
#' @return A \link[data.table]{data.table} showing the futures position
#'   Bloomberg tickers for which the \code{object} provided contains data.
#'
#'
#' @docType methods
#'
#' @rdname get_CFTC_tickers-methods
#'
#'
#' @importClassesFrom data.table data.table
#'
#'
#' @export
setGeneric("get_CFTC_tickers", function(object) standardGeneric("get_CFTC_tickers"))


# fields ####

## DataInfo, DataHistorical ####
#' Accesses the \code{fields} slot of various S4 objects from
#'   \href{https://github.com/bautheac/pullit/}{\pkg{pullit}}.
#'
#'
#' @description Access method for the \code{fields} slot of various S4 objects from the
#'   \href{https://github.com/bautheac/pullit/}{\pkg{pullit}} package.
#'
#'
#' @param object an S4 object of class \linkS4class{DataInfo} or
#'   \linkS4class{DataHistorical} or childs.
#'
#'
#' @return A \link[data.table]{data.table} showing for each Bloomberg ticker, the
#'   Bloomberg fields for which the \code{object} provided contains data.
#'
#'
#' @docType methods
#'
#' @rdname get_fields-methods
#'
#'
#' @importClassesFrom data.table data.table
#'
#'
#' @export
setGeneric("get_fields", function(object) standardGeneric("get_fields"))


# data ####

## DataHistorical ####
#' Accesses the \code{data} slot of various S4 objects from
#'   \href{https://github.com/bautheac/pullit/}{\pkg{pullit}}.
#'
#'
#' @description Access method for the \code{data} slot of various S4 objects from the
#'   \href{https://github.com/bautheac/pullit/}{\pkg{pullit}} package.
#'
#'
#' @param object an S4 object of class \linkS4class{DataHistorical} or childs.
#'
#'
#' @return A \link[data.table]{data.table} showing for each Bloomberg ticker and
#'   Bloomberg field the data contained in the \code{object} provided.
#'
#'
#' @docType methods
#'
#' @rdname get_data-methods
#'
#'
#' @importClassesFrom data.table data.table
#'
#'
#' @export
setGeneric("get_data", function(object) standardGeneric("get_data"))


# call ####

#' Accesses the \code{call} slot of various S4 objects in the
#'   \href{https://bautheac.github.io/finRes/}{\pkg{finRes}} suite.
#'
#'
#' @description Access method for the \code{call} slot of various S4
#'   objects in the
#'   \href{https://bautheac.github.io/finRes/}{\pkg{finRes}} suite.
#'
#'
#' @param object an S4 object of classes \linkS4class{DataInfo} or
#'   \linkS4class{DataHistorical} or respective childs.
#'
#'
#' @return The original call to the constructor function.
#'
#'
#' @docType methods
#'
#' @rdname get_call-methods
#'
#'
#' @export
setGeneric("get_call", function(object) standardGeneric("get_call"))


# periods ####

#' Shows the time periods for which various S4 objects output of
#'   \href{https://github.com/bautheac/pullit/}{\pkg{pullit}} contain data.
#'
#'
#' @description Returns a data.table showing, for various S4 objects output of
#'   \href{https://github.com/bautheac/pullit/}{\pkg{pullit}}, fo each Bloomberg
#'   ticker and field, the time periods for which the object contains data.
#'
#'
#' @param object an S4 object of class \linkS4class{DataHistorical} or childs.
#'
#'
#' @return A \link[data.table]{data.table} showing for each Bloomberg ticker and
#'   Bloomberg field the time periods for which the \code{object} provided
#'   contains data.
#'
#'
#' @docType methods
#'
#' @rdname get_periods-methods
#'
#'
#' @importClassesFrom data.table data.table
#'
#'
#' @export
setGeneric("get_periods", function(object) standardGeneric("get_periods"))