# skimpy

> skimpy

## Docs

### API Reference

#### Functions
> Utility functions

- [clean_columns](https://aeturrell.github.io/skimpy/reference/clean_columns.html): Clean messy column names in a pandas dataframe
- [generate_test_data](https://aeturrell.github.io/skimpy/reference/generate_test_data.html): Generate a pandas dataframe with several different datatypes
- [skim](https://aeturrell.github.io/skimpy/reference/skim.html): Skim a pandas or polars dataframe and return visual summary statistics on it
- [skim_get_data](https://aeturrell.github.io/skimpy/reference/skim_get_data.html): Skim a pandas or polars dataframe and return summary statistics as a dictionary, and without printing to the console
- [skim_get_figure](https://aeturrell.github.io/skimpy/reference/skim_get_figure.html): Skim a pandas or polars dataframe, print the stats to the console, and save a version of the table as an SVG, HTML, or text file

#### Constants
> Module-level constants and data

- [CASE_STYLES](https://aeturrell.github.io/skimpy/reference/CASE_STYLES.html): set() -> new empty set object
- [COMPLETE_COL](https://aeturrell.github.io/skimpy/reference/COMPLETE_COL.html): str(object='') -> str
- [DATE_COL_FIRST](https://aeturrell.github.io/skimpy/reference/DATE_COL_FIRST.html): str(object='') -> str
- [DATE_COL_LAST](https://aeturrell.github.io/skimpy/reference/DATE_COL_LAST.html): str(object='') -> str
- [HIST_BINS](https://aeturrell.github.io/skimpy/reference/HIST_BINS.html): int([x]) -> integer
- [MAX_COL_WIDTH](https://aeturrell.github.io/skimpy/reference/MAX_COL_WIDTH.html): int([x]) -> integer
- [MIN_COL_WIDTH](https://aeturrell.github.io/skimpy/reference/MIN_COL_WIDTH.html): int([x]) -> integer
- [MISSING_COL](https://aeturrell.github.io/skimpy/reference/MISSING_COL.html): str(object='') -> str
- [NULL_VALUES](https://aeturrell.github.io/skimpy/reference/NULL_VALUES.html): set() -> new empty set object
- [NUM_COL_MEAN](https://aeturrell.github.io/skimpy/reference/NUM_COL_MEAN.html): str(object='') -> str
- [QUANTILES](https://aeturrell.github.io/skimpy/reference/QUANTILES.html): Built-in mutable sequence