dir_path_db: Get Path of Data Directory from stock_db

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

Description

Generic function to get path of data directory from stock_db.

Usage

dir_path_db(
  stock_db,
  dir_id = c("DIR_DB_DATA", "DIR_DB_DATA_SOURCE", "DIR_DB_DATA_ORIGIN",
    "DIR_DB_DATA_LOG", "DIR_DB_DATA_INDICATOR"),
  force = TRUE,
  ...
)

## S4 method for signature 'gta_db'
dir_path_db(
  stock_db,
  dir_id = c("DIR_DB_DATA", "DIR_DB_DATA_SOURCE", "DIR_DB_DATA_ORIGIN",
    "DIR_DB_DATA_LOG", "DIR_DB_DATA_INDICATOR"),
  force = TRUE,
  ...
)

Arguments

stock_db	A stock database object to operate.
dir_id	A character id of directory. DIR_DB_DATA: dir of database of stock_db; DIR_DB_DATA_SOURCE : dir of source data to process into database; DIR_DB_DATA_ORIGIN: dir of origin data to import into database; DIR_DB_DATA_LOG: dir of log of database operation; DIR_DB_DATA_INDICATOR: dir of customized indicators.
force	Whether return result if dir doesn't existed. Default TRUE, return result if dir doesn't exist.
...	Extra arguments to be passed to methods.

Value

A full path of dir if succeed, otherwise NULL. If the path of dir doesn't exist and force = FALSE, it will raise a error.

Functions

• dir_path_db,gta_db-method: get path of data directory from a database of gta_db class

See Also

Other stock_db generics: close_stock_db(), code2name(), get_factors_info(), get_factors(), get_financial_report(), 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.