epyr.fair.validation

Data Validation Module for FAIR Compliance

This module provides validation functions to ensure data meets FAIR (Findable, Accessible, Interoperable, Reusable) principles and scientific data standards.

Features: - Metadata completeness validation - Data integrity checks - Format compliance verification - Scientific metadata standards validation

Functions

`create_validation_report`(result[, output_path])	Create a formatted validation report.
`validate_data_integrity`(x_data, y_data, metadata)	Validate data integrity and consistency.
`validate_epr_parameters`(metadata)	Validate EPR-specific measurement parameters.
`validate_fair_dataset`(data_dict[, file_path])	Comprehensive FAIR dataset validation.
`validate_fair_metadata`(metadata)	Validate metadata for FAIR compliance.
`validate_file_format`(file_path[, ...])	Validate file format and structure.

Classes

ValidationResult()

Container for validation results.

class epyr.fair.validation.ValidationResult[source]

Container for validation results.

__init__()[source]

add_error(message)[source]

Add an error message.

Parameters:: message (str)

add_warning(message)[source]

Add a warning message.

Parameters:: message (str)

add_info(message)[source]

Add an info message.

Parameters:: message (str)

get_summary()[source]

Get validation summary.

Return type:: Dict[str, Any]

epyr.fair.validation.validate_fair_metadata(metadata)[source]

Validate metadata for FAIR compliance.

Parameters:: metadata (Dict[str, Any]) – Metadata dictionary to validate
Returns:: ValidationResult with detailed findings
Return type:: ValidationResult

epyr.fair.validation.validate_data_integrity(x_data, y_data, metadata)[source]

Validate data integrity and consistency.

Parameters:

x_data (ndarray | None) – X-axis data array
y_data (ndarray) – Y-axis data array
metadata (Dict[str, Any]) – Associated metadata

Returns:

ValidationResult with findings

Return type:

ValidationResult

epyr.fair.validation.validate_epr_parameters(metadata)[source]

Validate EPR-specific measurement parameters.

Parameters:: metadata (Dict[str, Any]) – Metadata containing EPR parameters
Returns:: ValidationResult with EPR-specific validation
Return type:: ValidationResult

epyr.fair.validation.validate_file_format(file_path, expected_format=None)[source]

Validate file format and structure.

Parameters:

file_path (Path) – Path to file to validate
expected_format (str | None) – Expected format (csv, json, hdf5)

Returns:

ValidationResult with format validation

Return type:

ValidationResult

epyr.fair.validation.validate_fair_dataset(data_dict, file_path=None)[source]

Comprehensive FAIR dataset validation.

Parameters:

data_dict (Dict[str, Any]) – Dictionary containing data and metadata
file_path (Path | None) – Optional file path for format validation

Returns:

Combined ValidationResult

Return type:

ValidationResult

epyr.fair.validation.create_validation_report(result, output_path=None)[source]