validate_dataset_local()

Validate that a DataFrame is SDMX compliant and return a DataFrame of errors.

Usage

Source

validate_dataset_local(
    df, schema=None, valid=None, sdmx_cols=None, max_errors=1000
)

Either a schema or a precomputed valid object must be provided to avoid recomputing validation info for multiple datasets.

Parameters

df: pd.DataFrame

The DataFrame to be validated.

schema: Schema | None = None

The schema object (optional if valid is provided).

valid: dict[str, object] | None = None

Precomputed validation information returned by ~tidysdmx.utils.extract_validation_info() (optional).

sdmx_cols: list[str] | None = None

SDMX reference columns expected in the dataset. Defaults to ['STRUCTURE', 'STRUCTURE_ID', 'ACTION'].

max_errors: int = 1000

Maximum number of individual errors to report per validation check. Defaults to 1000.

Returns

pd.DataFrame

A DataFrame containing validation errors. Each row is one error, with

columns Validation and Error.