utils_profile: Utility functions of profile

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

Description

Utility functions to handle profile, which contains configuration information of stock database.

Usage

get_profile_path(profile_name, profile_dir = .PROFILE_DIR)

profile_get_varible_setting(profile_path, variable)

profile_get_factors(profile_path, factor_codes = NULL, factor_groups = NULL)

profile_get_datasource_files(profile_path)

profile_get_indicators(profile_path, indicator_codes = NULL)

profile_get_customized_indicators(profile_path)

Arguments

profile_name	A character of profile name, e.g. .GTA_PROFILE_FILE or "gta_profile.xlsx".
profile_dir	A character name of dir where profile is located. Default .PROFILE_DIR is etc in package directory.
profile_path	Path of profile to get data from.
variable	A character of name of variable to get.
factor_codes	A character vector of factor codes to fetch. Default NULL means to fetch all factors.
factor_groups	A character vector of factor groups to fetch. Default NULL means to fetch all factor groups.
indicator_codes	A character vector of indicator codes to fetch. Default NULL means to fetch all indicators.

Value

get_profile_path(): A path of profile if succeed, otherwise "".

others: A dataframe of setting if succeed, otherwise NULL.

Functions

• get_profile_path: get full path of profile.

• profile_get_varible_setting: get table name value from profile of database.

• profile_get_factors: get table name value from profile of database.

• profile_get_datasource_files: get data source for importing raw data.

• profile_get_indicators: get info of indicators from profile of database.

• profile_get_customized_indicators: get info of customized indicators from profile of database.

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