Data Validators

API reference for input data validation functions

1 Data Validators

Note

This reference is curated against the current app/logic/validators.R implementation. All validator functions return a 2-field list: list(is_valid = <logical>, message = <character>).

1.1 Overview

The validators module provides input file validation for GDS, SV, and CNV files.

Location: app/logic/validators.R

1.2 Key Functions

1.2.1 validate_gds_file()

Validates GDS file structure and required annotations.

Parameters: - gds_path (character): Path to GDS file

Returns: list(is_valid = <logical>, message = <character>)

1.2.2 validate_sv_tsv()

Validates AnnotSV TSV file structure and required columns.

Parameters: - tsv_path (character): Path to SV TSV file

Returns: list(is_valid = <logical>, message = <character>)

1.2.3 validate_cnv_txt()

Validates CNV TXT file structure.

Parameters: - cnv_path (character): Path to CNV TXT file

Returns: list(is_valid = <logical>, message = <character>)

1.3 Usage

box::use(
  app/logic/validators[validate_gds_file, validate_sv_tsv]
)

res <- validate_gds_file("sample_SNV_IMPACT.gds")
if (isTRUE(res$is_valid)) {
  # Proceed with loading
}

1.4 Validation Rules

See Input Specifications for detailed format requirements.

1.5 See Also