Documentation
¶
Overview ¶
Package add implements a command to add trees to a PhyGeo project.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var Command = &command.Command{
Usage: `add [-f|--file <tree-file>]
[--newick <name>] [--age <value>]
<project-file> [<tree-file>...]`,
Short: "add phylogenetic trees to a PhyGeo project",
Long: `
Command add read one or more trees from one or more tree files, and add the
trees to a PhyGeo project. The trees must be time calibrated trees.
The first argument of the command is the name of the project file. If no
project file exists, a new project will be created.
One or more tree files can be given as arguments. If no file is given the
tress will be read from the standard input.
By default, the input is expected to be in the form of tab-delimited tree
files. To import newick trees (i.e., trees in parenthetical format), use the
flag --newick with a name to be defined for the trees found in the input
files. It is expected that branch lengths were given in million years. By
default, the age of the root will be calculated from the largest branch length
between any terminal and the root. To set a different root age, use the
flag --age, with a value in million years.
By default the trees will be stored in the tree file currently defined for the
project. If the project does not have a tree file, a new one will be created
with the name 'trees.tab'. A different tree file name can be defined using the
flag --file, or -f. If this flag is used, and there is tree file already
defined, then a new file with that name will be created, and used as the tree
file for the project (previously defined trees will be kept).
`,
SetFlags: setFlags,
Run: run,
}
Functions ¶
This section is empty.
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.