VCF.Header (VCF v1.0.0)

View Source

A parsed VCF header with ordered metadata and sample names.

Summary

Types

column()
t()

Functions

definition(header, kind, id)

Returns the first declaration of id for the requested metadata kind.

Types

column()

@type column() ::
  :chrom | :pos | :id | :ref | :alt | :qual | :filter | :info | :format

t()

@type t() :: %VCF.Header{
  columns: [column()],
  metadata: [VCF.Metadata.t()],
  samples: [String.t()],
  version: VCF.Version.t(),
  warnings: [VCF.Warning.t()]
}

Functions

definition(header, kind, id)

@spec definition(t(), :info | :format | :filter | :alt | :contig, String.t()) ::
  VCF.FieldDefinition.t() | VCF.Metadata.t() | nil

Returns the first declaration of id for the requested metadata kind.