Documentation

VcfWriterInterface

Interface VcfWriterInterface - the counterpart of VcfReaderInterface : writes VcfVariant instances as a VCF file with its eight fixed columns (no FORMAT, no sample genotype).

Tags
author

Amélie DUVERNET aka Amelaye amelieonline@gmail.com

Table of Contents

Methods

write()  : string

Methods

write()

public write(array<string|int, VcfVariant> $aVariants[, array<string|int, string> $aMetaLines = [] ]) : string
Parameters
$aVariants : array<string|int, VcfVariant>
$aMetaLines : array<string|int, string> = []

Extra "##..." header lines (contig, INFO, FILTER definitions...) written after the file format line, with or without their leading "##"

Tags
throws
InvalidArgumentException

When an entry is not a VcfVariant, or a field cannot be written

Return values
string —

The file : the meta lines, the column header line, one line per variant

On this page

Search results