Reference
Download data
- download.download_data_constituents()
-
Download constituent data for a given stock index.
- download.download_data_damodaran()
-
Download and process Damodaran industry data.
- download.download_data_factors_ff()
-
Download and process Fama-French factor data.
- download.download_data_factors_q()
-
Download and process Global Q factor data.
- download.download_data_fred()
-
Download and process data from FRED.
- download.download_data_fred_md()
-
Download and process a FRED-MD / FRED-QD database (McCracken-Ng).
- download.download_data_jkp()
-
Download and process Global Factor Data.
- download.download_data_macro_predictors()
-
Download and process macro predictor data.
- download.download_data_osap()
-
Download and process Open Source Asset Pricing data.
- download.download_data_pastor_stambaugh()
-
Download and process Pastor-Stambaugh liquidity factors.
- download.download_data_stambaugh_yuan()
-
Download and process Stambaugh-Yuan mispricing factors.
- download.download_data_stock_prices()
-
Download stock data from Yahoo Finance.
- download.download_data_huggingface()
-
Download data from a Hugging Face dataset.
- download.download_data_risk_free()
-
Download risk-free rate data.
- download.download_data_wrds()
-
Download data from WRDS.
- download.download_data()
-
Download and process data based on domain and dataset.
Open Source
- download_open_source.list_supported_indexes()
-
Return a DataFrame of supported financial indexes.
- download_open_source.download_data_factors_ff()
-
Download and process Fama-French factor data.
- download_open_source.download_data_factors_q()
-
Download and process Global Q factor data.
- download_open_source.download_data_macro_predictors()
-
Download and process macro predictor data.
- download_open_source.download_data_constituents()
-
Download constituent data for a given stock index.
- download_open_source.download_data_fred()
-
Download and process data from FRED.
- download_open_source.download_data_fred_md()
-
Download and process a FRED-MD / FRED-QD database (McCracken-Ng).
- download_open_source.download_data_stock_prices()
-
Download stock data from Yahoo Finance.
- download_open_source.download_data_osap()
-
Download and process Open Source Asset Pricing data.
- download_open_source.download_data_pastor_stambaugh()
-
Download and process Pastor-Stambaugh liquidity factors.
- download_open_source.download_data_stambaugh_yuan()
-
Download and process Stambaugh-Yuan mispricing factors.
- download_open_source.download_data_jkp()
-
Download and process Global Factor Data.
- download_open_source.download_data_damodaran()
-
Download and process Damodaran industry data.
Tidy Finance
- download_tidy_finance.download_data_risk_free()
-
Download risk-free rate data.
- download_tidy_finance.get_available_huggingface_files()
-
List parquet files in a Hugging Face dataset.
- download_tidy_finance.download_factor_library_grid()
-
Download the factor library grid from Hugging Face.
- download_tidy_finance.download_factor_library_ids()
-
Download factor library returns for a vector of portfolio IDs.
- download_tidy_finance.download_data_huggingface()
-
Download data from a Hugging Face dataset.
WRDS
- download_wrds.download_data_risk_free()
-
Download risk-free rate data.
- download_wrds.download_data_wrds()
-
Download data from WRDS.
- download_wrds.download_data_wrds_crsp()
-
Download data from WRDS CRSP.
- download_wrds.download_data_wrds_ccm_links()
-
Download data from the WRDS CRSP/Compustat Merged (CCM) links database.
- download_wrds.download_data_wrds_compustat()
-
Download data from WRDS Compustat.
- download_wrds.download_data_wrds_fisd()
-
Download filtered FISD data from WRDS.
- download_wrds.download_data_wrds_trace_enhanced()
-
Download Enhanced TRACE data from WRDS.
- download_wrds.get_wrds_connection()
-
Establish a connection to Wharton Research Data Services (WRDS).
- download_wrds.disconnect_connection()
-
Close an open WRDS database connection.
- download_wrds.set_wrds_credentials()
-
Set WRDS credentials in a ‘.env’ file.
Pseudo Data
- download_pseudo.download_data_pseudo_crsp()
-
Generate pseudo CRSP data with the WRDS CRSP schema.
- download_pseudo.download_data_pseudo_compustat()
-
Generate pseudo Compustat data with the WRDS schema.
- download_pseudo.download_data_pseudo_ccm_links()
-
Generate a pseudo CRSP-Compustat linking table.
Portfolio analysis
- portfolios.data_options()
-
Create data options for tidyfinance functions.
- portfolios.breakpoint_options()
-
Create breakpoint options for portfolio sorting.
- portfolios.compute_breakpoints()
-
Compute breakpoints based on a sorting variable.
- portfolios.assign_portfolio()
-
Assign data points to portfolios based on a sorting variable.
- portfolios.filter_options()
-
Create filter options for sample construction.
- portfolios.portfolio_sort_options()
-
Create portfolio sort options.
- portfolios.compute_portfolio_returns()
-
Compute portfolio returns.
- portfolios.compute_long_short_returns()
-
Compute long-short returns.
- portfolios.filter_sorting_data()
-
Filter sorting data.
- portfolios.implement_portfolio_sort()
-
Implement a portfolio sort.
Estimation
- regression.estimate_betas()
-
Estimate rolling betas.
- regression.estimate_fama_macbeth()
-
Estimate Fama-MacBeth regressions.
- regression.estimate_model()
-
Estimate a linear model.
Rolling and lagging
- lagging.get_backend()
-
Return the active data frame backend (‘“polars”’ or ‘“pandas”’).
- lagging.add_lagged_columns()
-
Append lagged columns to a data frame via a join-based approach.
- lagging.join_lagged_values()
-
Join lagged values of variables over a date range.
- lagging.compute_rolling_value()
-
Compute a rolling value by period.
Supported datasets
- supported_datasets.list_supported_datasets()
-
List all datasets supported by ‘download_data’.
- supported_datasets.list_supported_types()
-
List supported datasets (deprecated alias).
Utilities
- utilities.create_summary_statistics()
-
Create summary statistics for specified variables.
- utilities.list_supported_indexes()
-
Return a DataFrame of supported financial indexes.
- utilities.list_supported_jkp_factors()
-
Return the regions and factors supported by Global Factor Data.
- utilities.list_tidy_finance_chapters()
-
Return the chapter slugs of the Tidy Finance book.
- utilities.open_tidy_finance_website()
-
Open the Tidy Finance website or a specific chapter.
- utilities.winsorize()
-
Winsorize a numeric vector at symmetric quantiles.
- utilities.trim()
-
Trim a numeric vector by setting extreme observations to NaN.
Backend
- backend.set_backend()
-
Set the global data frame backend for the tidyfinance API.
- backend.get_backend()
-
Return the active data frame backend (‘“polars”’ or ‘“pandas”’).