otld.utils.checks.CaseloadDataChecker

class otld.utils.checks.CaseloadDataChecker(df: DataFrame | dict[DataFrame], level: str = '', action: str = 'error')

Bases: GenericChecker

__init__(df: DataFrame | dict[DataFrame], level: str = '', action: str = 'error')

Initialize CaseloadDataChecker

Args:

df (pd.DataFrame): Caseload data DataFrame level (str): Funding level (TANF, TANF-SSP, SSP-MOE) action (str, optional): Action to take when an assertion fails. Defaults to “error”.

Methods

__init__(df[, level, action])	Initialize CaseloadDataChecker
caseload_data_checks()	Generic caseload data checks
check()	Run caseload data checks
export(path[, sheet_name])	Export checks to a workbook

Attributes

action	Action to be taken when an assertion fails
df	Financial data frame
kind	ACF Instructions (196, 196R, Appended)
level	Funding level (State, Federal, Total)

property action

Action to be taken when an assertion fails

caseload_data_checks()

Generic caseload data checks

check()

Run caseload data checks

property df

Financial data frame

export(path: str | PathLike, sheet_name: str = None, **kwargs) → None

Export checks to a workbook

Args:

path (str | os.PathLike): Path to export checks to. sheet_name (str, optional): An optional sheet name for the checks. Defaults to None.

property kind

ACF Instructions (196, 196R, Appended)

property level

Funding level (State, Federal, Total)