sf_quant.data.get_factors_columns

sf_quant.data.get_factors_columns() → str

Return the available columns in the factors dataset.

This function provides a schema of all factors that can be retrieved with load_factors(). The output is a table listing each column name along with its corresponding data type.

Returns

str

A string representation of a polars data frame containing the column names and types for the factors table.

Examples

>>> import sf_quant.data as sfd
>>> sfd.get_factors_columns()
shape: (78, 2)
┌──────────────────┬─────────┐
│ column           ┆ dtype   │
│ ---              ┆ ---     │
│ str              ┆ str     │
╞══════════════════╪═════════╡
│ date             ┆ Date    │
│ USSLOWL_AERODEF  ┆ Float64 │
│ USSLOWL_AIRLINES ┆ Float64 │
│ USSLOWL_ALUMSTEL ┆ Float64 │
│ USSLOWL_APPAREL  ┆ Float64 │
│ USSLOWL_AUTO     ┆ Float64 │
│ ...              ┆ ...     │
└──────────────────┴─────────┘