get_financial_report: Get financial report timeseries from stock_db

In chriszheng2016/zstmodelr: Stock Factor Models for China Stock Market Investment

Description

Generic function to get financial report timeseries from stock_db.

Usage

get_financial_report(
  stock_db,
  stock_cd_list = NULL,
  statement = c("balance_sheet", "income", "cashflow_direct", "cashflow_indirect",
    "income_ttm", "cashflow_direct_ttm", "cashflow_indirect_ttm"),
  consolidated = TRUE,
  period_type = c("quarter", "year"),
  period_date = c("end", "start"),
  ...
)

## S4 method for signature 'gta_db'
get_financial_report(
  stock_db,
  stock_cd_list = NULL,
  statement = c("balance_sheet", "income", "cashflow_direct", "cashflow_indirect",
    "income_ttm", "cashflow_direct_ttm", "cashflow_indirect_ttm"),
  consolidated = TRUE,
  period_type = c("quarter", "year"),
  period_date = c("end", "start"),
  ...
)

Arguments

stock_db	A stock database object to operate.
stock_cd_list	A character vector of stock cd, default value of NULL means. all stock data will be returned.
statement	A string of statement type, i.e. "balance_sheet", "income", "cashflow_direct","cashflow_indirect", "income_ttm", "cashflow_direct_ttm", "cashflow_indirect_ttm".
consolidated	A logic indicate report is consolidated or not. Default TRUE means consolidated report, FALSE means parent company report.
period_type	Date period for time series, e.g. "quarter", "year", by default value is "quarter".
period_date	Choose start/end date of period as the date for observation
...	Extra arguments to be passed to methods.

Value

A data frame of report timeseries if succeed, otherwise NULL.

Functions

• get_financial_report,gta_db-method: get financial report timeseries from a database of gta_db class

See Also

Other stock_db generics: close_stock_db(), code2name(), dir_path_db(), get_factors_info(), get_factors(), get_indicators_from_source(), get_indicators_info(), get_indicators(), get_industry_info(), get_market_return(), get_profile(), get_riskfree_rate(), get_spt_stocks(), get_stock_dataset(), get_stock_industry(), get_stock_info(), get_stock_return(), get_table_dataset(), init_stock_db(), list_stock_tables(), name2code(), open_stock_db(), save_indicators_to_source()

chriszheng2016/zstmodelr documentation built on June 13, 2021, 8:59 p.m.