A library for working with phylogenetic and population genetic data.
v0.27.0
PhylipReader::Header Struct Reference

#include <genesis/sequence/formats/phylip_reader.hpp>

Detailed Description

Helper that stores the header information of a Phylip file.

Definition at line 97 of file phylip_reader.hpp.

Public Attributes

size_t len_sequences = 0
 Length of the sequences in the Phylip file. More...
 
size_t num_sequences = 0
 Number of sequences in the Phylip file. More...
 
std::string options
 Store the options that might be at the end of the header line. More...
 

Member Data Documentation

◆ len_sequences

size_t len_sequences = 0

Length of the sequences in the Phylip file.

Definition at line 107 of file phylip_reader.hpp.

◆ num_sequences

size_t num_sequences = 0

Number of sequences in the Phylip file.

Definition at line 102 of file phylip_reader.hpp.

◆ options

std::string options

Store the options that might be at the end of the header line.

Some Phylip files contain special options after the two mandatory numbers in the header line. This data can be stored here. It is currenlty not used.

Some programs use magic values for those options: If the (trimmed) remainder of the header line is simply "s" or "i", this is used as a trigger to distinguish between sequential and interleaved Phylip files. This is however currently not used. See Mode for more information.

Definition at line 120 of file phylip_reader.hpp.


The documentation for this struct was generated from the following file: