Skip to content

Commit 89391de

Browse files
James BarbettiJames Barbetti
James Barbetti
authored and
James Barbetti
committed
Updated list of files in example folder in Command_Line_Examples.md
1 parent 208c783 commit 89391de

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

doco/Command_Line_Examples.md

+14-13
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
<h1>Command-line Examples for decenttree</h1>
2-
In these examples, **decenttree** is being run in the build
3-
subdirectory (the example folder of the project is a sibling
4-
of the build directory). If the relative path to the example
5-
folder is different you will have to replace ../example in
6-
file path parameters.
7-
<p>
2+
In these examples, <b>decenttree</b> is being run in the build subdirectory (on MacOS, the example folder of the project is a sibling of the build directory). If the relative path to the example folder is different you will have to replace ../example in file path parameters.
3+
<br><br>
84
The files, in the *example* directory, that these command-line examples make use of, are:
9-
<ul>
10-
<li> example.phy is a small (17-taxon) example alignment (in un-interleaved phylip example format) </li>
11-
<li> example.phy is the same alignment, compressed with gzip </li>
12-
<li> example.dist is a distance matrix (in square phylip distance matrix
13-
format) </li>
14-
<li> compressed_example.dist.gz is the same distance matrix, compressed with gzip </li>
155

16-
</ul>
6+
|File|Content|
7+
|----|-------|
8+
|<b>example.phy</b>| a small (17-taxon) example alignment (in un-interleaved phylip sequence format)|
9+
|<b>compressed_example.phy.gz</b>| the same alignment, compressed with gzip |
10+
|<b>interleaved_example.phy</b>| the same alignment, uncompressed, in an interleaved Phylip sequence format)|
11+
|<b>example.dist</b>|a distance matrix (in square phylip distance matrix format, generated from the sequence data in example.phy|
12+
|<b>compressed_example.dist.gz</b>|the same distance matrix, compressed with gzip|
13+
|<b>uncorrected.dist</b>|a distance matrix, of uncorrected distances, generated from the sequence data in example.phy|
14+
|<b>simulated_1k.fa.gz</b>|a fasta file containing a simulated alignment with 1000 taxa, and a sequence length of 10,000|
15+
|<b>3x3.phy</b>|a dummy 3 taxon, 3 nucleotide input, which has A, C, or T, but not G sites (this is a very artificial example used for testing the function of "imputed alphabet" and non-standard alphabet command-line options)|
16+
17+
<h2>Simplest examples (to get version and usage)</h2>
1718

1819
|Command line|Explanation|
1920
|------------|-----------|

0 commit comments

Comments
 (0)