sf_quant.data.get_crsp_monthly_columns

sf_quant.data.get_crsp_monthly_columns() → str

Return the available columns in the CRSP monthly dataset.

This function returns a string representation of the CRSP monthly table schema as exposed by Polars. It can be used to inspect which columns are available for use with load_crsp_monthly().

Returns

str

A string representation of the column names and types.

Examples

>>> import sf_quant.data as sfd
>>> sfd.get_crsp_monthly_columns()
shape: (n, 2)
┌───────────────┬─────────┐
│ column        ┆ dtype   │
│ ---           ┆ ---     │
│ permno        ┆ Int64   │
│ date          ┆ Date    │
│ ret           ┆ Float64 │
│ ...           ┆ ...     │
└───────────────┴─────────┘