Header menu logo BioFSharp

Newick Module

Contains functions for parsing phylogenetic trees in the Newick format

Functions and values

Function or value Description

ofFile converter path

Full Usage: ofFile converter path

Parameters:
    converter : string -> 'Distance
    path : string

Returns: PhylogeneticTree<string * 'Distance>

Returns a PhylTree of file. Converter is used to create a distancevalue of a string

converter : string -> 'Distance
path : string
Returns: PhylogeneticTree<string * 'Distance>

toFile nodeConverter path tree

Full Usage: toFile nodeConverter path tree

Parameters:
    nodeConverter : 'T -> string * string
    path : string
    tree : PhylogeneticTree<'T>

Creates a NewickTree file of PhylTree. nodeConverter is used to split the distanceInfo and the name of a node, because they are parsed separately. First result of the tuple is name, second is distance.

nodeConverter : 'T -> string * string
path : string
tree : PhylogeneticTree<'T>

Type something to start searching.