Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
niemasd committed Apr 5, 2018
1 parent 831d45e commit aaa3341
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ Note that TreeCluster can run within seconds even on ultra-large datasets, so it

## Usage
```bash
usage: TreeCluster.py [-h] [-i INPUT] -t THRESHOLD [-s SUPPORT]
[-m METHOD]
usage: TreeCluster.py [-h] [-i INPUT] -t THRESHOLD [-s SUPPORT] [-m METHOD] [-tf THRESHOLD_FREE]

optional arguments:
-h, --help show this help message and exit
Expand All @@ -24,6 +23,9 @@ optional arguments:
Clustering Method (options: avg_clade, length,
length_clade, max, max_clade, med_clade, root_dist,
single_linkage_clade) (default: max_clade)
-tf THRESHOLD_FREE, --threshold_free THRESHOLD_FREE
Threshold-Free Approach (options: argmax_clusters)
(default: None)
```

## Clustering Methods
Expand Down Expand Up @@ -71,5 +73,8 @@ optional arguments:
3. Leaves cannot be connected by branches with support below *s*
* For a tree with *n* leaves, this algorithm is O(*n*)

## Threshold-Free Approaches
* **Argmax Clusters:** Choose the threshold that maximizes the number of non-singleton clusters over all thresholds from 0 to *t*

## Requirements
* [Biopython](http://biopython.org/)

0 comments on commit aaa3341

Please sign in to comment.