VCF.Validator (VCF v1.0.0)

View Source

Validates typed headers and records against their declared VCF version.

Summary

Functions

validate(header, records)

Validates a header and an enumerable of records without stopping at the first error.

validate_header(header, options \\ [])

Returns all independently detectable header errors in source order.

validate_record(record, header, options \\ [])

Returns all independently detectable record errors.

Functions

validate(header, records)

@spec validate(VCF.Header.t(), Enumerable.t()) :: [VCF.Error.t()]

Validates a header and an enumerable of records without stopping at the first error.

validate_header(header, options \\ [])

@spec validate_header(
  VCF.Header.t(),
  keyword()
) :: [VCF.Error.t()]

Returns all independently detectable header errors in source order.

validate_record(record, header, options \\ [])

@spec validate_record(VCF.Record.t(), VCF.Header.t(), keyword()) :: [VCF.Error.t()]

Returns all independently detectable record errors.