MetadataImport

Parsed metadata from an external standard.

Usage

MetadataImport()

Contains variable definitions, value labels, missing value codes, controlled terminologies, and dataset-level metadata: all mapped to Pointblank concepts.

Parameters

source_format: str: The format this metadata was imported from (e.g., "spss", "xpt", "stata").
source_path: str | None = None: Path to the source file, if imported from a file.
source_version: str | None = None: Version of the source format/standard.
dataset_name: str | None = None: Name of the dataset.
dataset_label: str | None = None: Human-readable label for the dataset.
dataset_description: str | None = None: Description of the dataset.
creation_date: str | None = None: When the dataset/metadata was created.
study_id: str | None = None: Study identifier (for clinical data).
domain: str | None = None: Domain identifier (e.g., "DM", "AE" for CDISC).
variables: list[VariableMetadata] = list(): List of variable metadata definitions.
codelists: dict[str, Codelist] = dict(): Named codelists (controlled terminologies).
missing_value_codes: dict[str, list[MissingValueCode]] = dict(): Named missing value code definitions.

Attributes

Name	Description
variable_names	Get the list of all variable names.

variable_names

Get the list of all variable names.

variable_names: list[str]

Methods

Name	Description
get_codelist()	Get a specific codelist by name.
get_variable()	Get metadata for a specific variable by name.
summary()	Return a human-readable summary of the imported metadata.
to_schema()	Convert imported metadata to a Pointblank Schema with `Field` objects.
to_validate()	Generate a Validate workflow from the imported metadata.

get_codelist()

Get a specific codelist by name.

Usage

Source

get_codelist(name)

Parameters

name: str: The codelist name or identifier.

Returns

Codelist: The requested codelist.

Raises

KeyError: If no codelist with that name exists.

get_variable()

Get metadata for a specific variable by name.

Usage

Source

get_variable(name)

Parameters

name: str: The variable name to look up.

Returns

VariableMetadata: The metadata for the named variable.

Raises

KeyError: If no variable with that name exists.

summary()

Return a human-readable summary of the imported metadata.

Usage

Source

summary()

Returns

str: Formatted summary string.

to_schema()

Convert imported metadata to a Pointblank Schema with Field objects.

Usage

Source

to_schema()

Maps variable metadata to appropriate Field types with constraints (min/max, allowed values, nullable, etc.).

Returns

Schema: A Pointblank Schema object with typed fields.

to_validate()

Generate a Validate workflow from the imported metadata.

Usage

Source

to_validate(data, **kwargs)

Creates validation steps for all constraints found in the metadata: value ranges, allowed values, required fields, string lengths, etc.

Parameters

data: Any: The DataFrame or table to validate.
**kwargs: Any: Additional keyword arguments passed to the Validate constructor.

Returns

Validate: A configured (but not yet interrogated) Validate object.