README.md 3.23 KB
Newer Older
Alexis  CRISCUOLO's avatar
Alexis CRISCUOLO committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
# REQ

_REQ_ is a command line program written in [Java](https://docs.oracle.com/javase/8/docs/technotes/guides/language/index.html) that allows estimating the rate of elementary quartets (REQ) for each internal branch of a phylogenetic tree from a distance matrix, as described by [Guénoche and Garreta (2001)](https://doi.org/10.1007/3-540-45727-5_5).

## Compilation and execution

The source code of _REQ_ is inside the _src_ directory and could be compiled and executed in two different ways. 

#### Building an executable jar file

On computers with [Oracle JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html) (6 or higher) installed, a Java executable jar file could be created. In a command-line window, go to the _src_ directory and type:
```bash
javac REQ.java 
echo Main-Class: REQ > MANIFEST.MF 
jar -cmvf MANIFEST.MF REQ.jar REQ.class 
rm MANIFEST.MF REQ.class 
```
This will create the executable jar file `REQ.jar` that could be launched with the following command line model:
```bash
java -jar REQ.jar [files]
```

#### Building a native code binary

On computers with the [GNU compiler GCJ](https://gcc.gnu.org/onlinedocs/gcc-4.2.4/gcj/) installed, a binary could also be built. In a command-line window, go to the _src_ directory, and type:
```bash
make
```
This will create the executable binary file `req` that could be launched with the following command line model:
```bash
./req [files]
```

## Usage

Launch _REQ_ without option to read the following documentation:

```
Alexis  CRISCUOLO's avatar
Alexis CRISCUOLO committed
39 40 41 42 43 44 45 46
 USAGE:  REQ  <dfile>  <tfile>  <outfile>  [-v]

   <dfile>    distance matrix file in either PHYLIP lower-triangular or
              square format
   <tfile>    unrooted binary phylogenetic tree file with no confidence
              value at branches in NEWICK format
   <outfile>  outfile name
   -v         verbose mode
Alexis  CRISCUOLO's avatar
Alexis CRISCUOLO committed
47 48 49 50 51 52 53 54 55 56
```

## Example

The directory _example_ contains two files from the study of [Garcia-Hermoso et al. (2018)](https://doi.org/10.1128/mBio.00573-18):     
* _matrix.d_: a distance matrix in PHYLIP square format estimated from 22 _Mucor circinelloides_ f. _circinelloides_ genomes,
* _tree.t_: the associated Minimum Evolution phylogenetic tree in NEWICK format.

The following command line writes into the file _tree.req.t_ the phylogenetic tree from _example/tree.t_ with the rate of elementary quartets at each internal branch estimated from the distance matrix _example/matrix.d_:
```bash
Alexis  CRISCUOLO's avatar
Alexis CRISCUOLO committed
57
REQ  example/matrix.d  example/tree.t  tree.req.t
Alexis  CRISCUOLO's avatar
Alexis CRISCUOLO committed
58 59 60 61 62 63 64
```

## References

Garcia-Hermoso D, Criscuolo A, Lee SC, Legrand M, Chaouat M, Denis B, Lafaurie M, Rouveau M, Soler C, Schaal JV, Mimoun M, Mebazaa A, Heitman J, Dromer F, Brisse S, Bretagne S, Alanio A (2018) Outbreak of invasive wound mucormycosis in a burn unit due to multiple strains of _Mucor circinelloides_ f. _circinelloides_ resolved by whole-genome sequencing. MBio, 24;9(2):e00573-18. [doi:10.1128/mBio.00573-18](https://doi.org/10.1128/mBio.00573-18).

Guénoche A, Garreta H (2001) Can we have confidence in a tree representation? _In_: Gascuel O, Sagot MF (eds) Computational Biology. Lecture Notes in Computer Science, vol 2066. Springer, Berlin, Heidelberg. [doi:10.1007/3-540-45727-5_5](https://doi.org/10.1007/3-540-45727-5_5). [[pdf]](http://iml.univ-mrs.fr/editions/biblio/guenoche/QualiTree-1.pdf)