list_supported_types {tidyfinance} | R Documentation |
List All Supported Dataset Types
Description
This function aggregates and returns a comprehensive tibble of all supported dataset types from different domains. It includes various datasets across different frequencies (daily, weekly, monthly, quarterly, annual) and models (e.g., q5 factors, Fama-French 3 and 5 factors, macro predictors).
Usage
list_supported_types(domain = NULL, as_vector = FALSE)
Arguments
domain |
A character vector to filter for domain specific types (e.g. c("WRDS", "Fama-French")) |
as_vector |
Logical indicating whether types should be returned as a character vector instead of data frame. |
Value
A tibble aggregating all supported dataset types with columns: type
(the type of dataset), dataset_name
(a descriptive name or file name of
the dataset), and domain
(the domain to which the dataset belongs, e.g.,
"Global Q", "Fama-French", "Goyal-Welch").
Examples
# List all supported types as a data frame
list_supported_types()
# Filter by domain
list_supported_types(domain = "WRDS")
# List supported types as a vector
list_supported_types(as_vector = TRUE)
[Package tidyfinance version 0.4.4 Index]