Skip to content

Commit

Permalink
adding README
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonGreenhill committed Feb 22, 2016
1 parent c4ecb13 commit c6aebcf
Showing 1 changed file with 26 additions and 7 deletions.
33 changes: 26 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ A python library for creating a Newick formatted tree from a set of classificati

## Usage: Command line


Basic usage:

```shell
Expand All @@ -17,16 +16,36 @@ Basic usage:
usage: treemaker [-h] filename
```

Construct tree for filename
e.g. Given a text file:

LangA Indo-European, Germanic
LangB Indo-European, Germanic
LangC Indo-European, Romance
LangD Indo-European, Anatolian

```shell
> treemaker
> treemaker classification.txt
(LangD,(LangA,LangB),LangC)

taxon1 0.2453
taxon2 0.2404
taxon3 0.2954
...
> treemaker -m nexus classification.txt

#NEXUS

begin trees;
tree root = (LangD,(LangA,LangB),LangC);
end;
```

To write to file:

```shell
> treemaker classification.txt
(LangD,(LangA,LangB),LangC)

> treemaker classification.txt -o classification.nex
```


## Usage: Library

```python
Expand Down

0 comments on commit c6aebcf

Please sign in to comment.