draw

Documentation

Overview

Package draw implements a command to draw trees in a phygeo project as SVG files.

Index

• Variables

Variables

var Command = &command.Command{
	Usage: `draw [--tree <tree>]
	[--step <value>] [--time <number>] [--tick <tick-value>]
	[-o|--output <out-prefix>]
	<project-file>`,
	Short: "draw project trees as SVG files",
	Long: `
Command draw reads a PhyGeo project and draws the trees into a SVG-encoded
file.

The argument of the command is the name of the project file.

If the --time flag is defied, then a gray box of the indicated size, in
million years, will be printed as background.

By default, 10 pixel units will be used per million years; use the flag --step
to define a different value (it can have decimal points).

By default, all trees in the project will be drawn. If the flag --tree is set,
only the indicated tree will be printed.

By default, a timescale with ticks every million years will be added at the
bottom of the drawing. Use the flag --tick to define the tick lines, using the
following format: "<min-tick>,<max-tick>,<label-tick>", in which min-tick
indicates minor ticks, max-tick indicates major ticks, and label-tick the
ticks that will be labeled; for example, the default is "1,5,5" which means
that small ticks will be added each million years, major ticks will be added
every 5 million years, and labels will be added every 5 million years.

By default, the names of the trees will be used as the output file names. Use
the flag -o, or --output, to define a prefix for the resulting files.
	`,
	SetFlags: setFlags,
	Run:      run,
}