Name: mta-nf
Owner: Notredame Lab
Description: Method for best alignment of evaluation trees
Created: 2014-09-15 10:49:42.0
Updated: 2017-03-21 11:05:13.0
Pushed: 2017-10-13 19:52:30.0
Size: 570
Language: C
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
MTA-NF is a Multiple Sequence Alignment pipeline to align multiple guide-tree variations for the same input sequences, evaluating the alignments obtained and selecting the best one as result. MTA method can be applied to any progressive method that accepts guide trees as an input parameter (in this version accepts T-Coffee, ClustalW and ClustalO). In addition, the method also allows different evaluation metrics to select the best multiple guide trees (sp, normd). The aim is to find a variation of the original tree that provides a more accurate alignment than the original one produced. MTA-NF is implemented using the Nextflow framework.
Clone the git repository on your computer with the following command:
$ git clone git@github.com:orobitg/mta-nf.git
Run the script install.sh to download, compile and install the tools listed below (if you are not using Docker).
When done, move in the project root folder named mta-nf,
which contains an example dataset in the tutorial folder.
Launch the pipeline by entering the following command on your shell terminal:
$ ./nextflow run mta.nf
By default the pipeline is executed against the provided tutorial dataset. Check the Pipeline parameters section below to see how enter your data on the program command line.
–seq
$ ./nextflow run mta.nf --seq /home/user/seq/example.fa–ntree
$ ./nextflow run mta.nf --ntree 100–msa
$ ./nextflow run mta.nf --msa t_coffee–score
$ ./nextflow run mta.nf --score sp–gop
$ ./nextflow run mta-nf --score sp --gop -11–gep
$ ./nextflow run mta-nf --score sp --gep -1–matrix
$ ./nextflow run mta-nf --score sp --matrix blosum62mt–output
$ ./nextflow run mta-nf --output /home/user/my_resultsCommand line
Install all the dependencies running the bash script install.sh.
$ bash install.sh`
Run nextflow mta-nf command line indication all the input parameters. For example:
$ ./nextflow run mta-nf --seq /home/user/seq.fasta --ntree 100 --msa t_coffee --score sp --output /home/user/results
Configuration file
The user can modify the nextflow.config or create a new config file adding the parameters information:
params {
seq = '/home/user/seq.fasta'
ntree = 100
msa = 't_coffee'
score = 'sp'
gop = '-11'
gep = '-1'
matrix = 'blosum62mt'
output = '/home/user/results'
}
If you are running MTA-NF with a configuration file different to the nextflow.config, use the following command line:
$ nextflow -c /home/user/example.config run mta-nf
More information about nextflow configuration files in http://www.nextflow.io/docs/latest/config.html
MTA-NF dependecies are also distributed by using a Docker container which frees you from the installation and configuration of all the pieces of software required by MTA-NF.
The MTA-NF Docker image is published at this address https://registry.hub.docker.com/u/cbcrg/mta-nf/
If you have Docker installed in your computer pull this image by entering the following command:
$ docker pull cbcrg/mta-nf
After that you will be able to run MTA-NF using the following command line:
$ nextflow run cbcrg/mta-nf -with-docker
MTA-NF execution relies on Nextflow framework which provides an abstraction between the pipeline functional logic and the underlying processing system.
Thus it is possible to execute it on your computer or any cluster resource manager without modifying it.
Currently the following clusters are supported:
By default the pipeline is parallelized by spanning multiple threads in the machine where the script is launched.
To submit the execution to a SGE cluster create a file named nextflow.config, in the directory
where the pipeline is going to be launched, with the following content:
task {
processor='sge'
queue='<your queue name>'
clusterOptions = '<SGE parameters>'
}
In doing that, tasks will be executed through the qsub SGE command, and so your pipeline will behave like any
other SGE job script, with the benefit that Nextflow will automatically and transparently manage the tasks
synchronisation, file(s) staging/un-staging, etc. In clusterOptions, the user can specify the SGE parameters such as the name of the job (-N Name), the e-mail (-M email), the sge enviroment (-pe smp 8), …
Alternatively the same declaration can be defined in the file $HOME/.nextflow/config.
To lean more about the avaible settings and the configuration file read the Nextflow documentation http://www.nextflow.io/docs/latest/config.html