OrthoFinder-Sapelo2: Difference between revisions
No edit summary |
No edit summary |
||
Line 51: | Line 51: | ||
<pre class="gscript"> | <pre class="gscript"> | ||
#!/bin/bash | #!/bin/bash | ||
# | #SBATCH --job-name=j_OrthoFinder | ||
# | #SBATCH --partition=batch | ||
# | #SBATCH --ntasks=1 | ||
# | #SBATCH --cpus-per-task=2 | ||
# | #SBATCH --mem=10gb | ||
#SBATCH --time=120:00:00 | |||
#SBATCH --output=log.%j.out | |||
#SBATCH --error=log.%j.err | |||
#SBATCH --mail-user=username@uga.edu | |||
#SBATCH --mail-type=ALL | |||
cd $ | cd $SLURM_SUBMIT_DIR | ||
ml OrthoFinder/2.5.2-foss-2019b-Python-3.7.4 | |||
orthofinder.py [options] | orthofinder.py [options] | ||
</pre> | </pre> | ||
Here is an example of job submission | Here is an example of job submission | ||
<pre class="gcommand"> | <pre class="gcommand"> | ||
sbatch ./sub.sh | |||
</pre> | </pre> | ||
Line 106: | Line 78: | ||
<pre class="gcommand"> | <pre class="gcommand"> | ||
ml OrthoFinder/2.5.2-foss-2019b-Python-3.7.4 | |||
zhuofei@b1-24 ~$ orthofinder -h | |||
OrthoFinder version 2.5.2 Copyright (C) 2014 David Emms | |||
OrthoFinder version 2. | |||
SIMPLE USAGE: | SIMPLE USAGE: | ||
Line 120: | Line 91: | ||
OPTIONS: | OPTIONS: | ||
-t <int> | -t <int> Number of parallel sequence search threads [Default = 64] | ||
-a <int> | -a <int> Number of parallel analysis threads | ||
-M <txt> | -d Input is DNA sequences | ||
-M <txt> Method for gene tree inference. Options 'dendroblast' & 'msa' | |||
-S <txt> | [Default = dendroblast] | ||
-S <txt> Sequence search program [Default = diamond] | |||
-A <txt> | Options: blast, diamond, diamond_ultra_sens, blast_gz, mmseqs, blast_nucl | ||
-A <txt> MSA program, requires '-M msa' [Default = mafft] | |||
-T <txt> | Options: mafft, muscle | ||
-T <txt> Tree inference method, requires '-M msa' [Default = fasttree] | |||
Options: fasttree, raxml, raxml-ng, iqtree | |||
-s <file> User-specified rooted species tree | |||
-s <file> | -I <int> MCL inflation parameter [Default = 1.5] | ||
-I <int> | -x <file> Info for outputting results in OrthoXML format | ||
-x <file> | -p <dir> Write the temporary pickle files to <dir> | ||
-p <dir> | -1 Only perform one-way sequence search | ||
-1 | -X Don't add species names to sequence IDs | ||
-n <txt> | -y Split paralogous clades below root of a HOG into separate HOGs | ||
-h | -z Don't trim MSAs (columns>=90% gap, min. alignment length 500) | ||
-n <txt> Name to append to the results directory | |||
-o <txt> Non-default results directory | |||
-h Print this help text | |||
WORKFLOW STOPPING OPTIONS: | WORKFLOW STOPPING OPTIONS: | ||
-op | -op Stop after preparing input files for BLAST | ||
-og | -og Stop after inferring orthogroups | ||
-os | -os Stop after writing sequence files for orthogroups | ||
(requires '-M msa') | |||
-oa | -oa Stop after inferring alignments for orthogroups | ||
(requires '-M msa') | |||
-ot | -ot Stop after inferring gene trees for orthogroups | ||
WORKFLOW RESTART COMMANDS: | WORKFLOW RESTART COMMANDS: | ||
Line 159: | Line 133: | ||
CITATION: | CITATION: | ||
When publishing work that uses OrthoFinder please cite: | When publishing work that uses OrthoFinder please cite: | ||
Emms D.M. & Kelly S. ( | Emms D.M. & Kelly S. (2019), Genome Biology 20:238 | ||
If you use the species tree in your work then please also cite: | |||
Emms D.M. & Kelly S. (2017), MBE 34(12): 3267-3278 | |||
Emms D.M. & Kelly S. (2018), bioRxiv https://doi.org/10.1101/267914 | |||
</pre> | </pre> | ||
[[#top|Back to Top]] | [[#top|Back to Top]] |
Revision as of 10:10, 20 May 2021
Category
Bioinformatics
Program On
Sapelo2
Version
2.3.8, 2.3.11, 2.5.2
Author / Distributor
Description
"OrthoFinder is a fast, accurate and comprehensive analysis tool for comparative genomics. It finds orthologues and orthogroups infers rooted gene trees for all orthogroups and infers a rooted species tree for the species being analysed. OrthoFinder also provides comprehensive statistics for comparative genomic analyses. OrthoFinder is simple to use and all you need to run it is a set of protein sequence files (one per species) in FASTA format." More details are at OrthoFinder
Running Program
Also refer to Running Jobs on Sapelo2 Also refer to Run X window Jobs and Run interactive Jobs
- Version 2.3.8, installed at /apps/eb/OrthoFinder/2.3.8-foss-2019b-Python-2.7.16
- Version 2.3.11, installed at /apps/eb/OrthoFinder/2.3.11-intel-2019b-Python-3.7.4
- Version 2.5.2, installed at /apps/eb/OrthoFinder/2.5.2-foss-2019b-Python-3.7.4
To use the version 2.3.8, please first load the module with
ml OrthoFinder/2.3.8-foss-2019b-Python-2.7.16
To use the version 2.3.1, please first load the module with
ml OrthoFinder/2.3.11-intel-2019b-Python-3.7.4
To use the version 2.5.2, please first load the module with
ml OrthoFinder/2.5.2-foss-2019b-Python-3.7.4
Here is an example of a shell script sub.sh to run orthofinder.py of version 2.5.2 at the batch queue:
#!/bin/bash #SBATCH --job-name=j_OrthoFinder #SBATCH --partition=batch #SBATCH --ntasks=1 #SBATCH --cpus-per-task=2 #SBATCH --mem=10gb #SBATCH --time=120:00:00 #SBATCH --output=log.%j.out #SBATCH --error=log.%j.err #SBATCH --mail-user=username@uga.edu #SBATCH --mail-type=ALL cd $SLURM_SUBMIT_DIR ml OrthoFinder/2.5.2-foss-2019b-Python-3.7.4 orthofinder.py [options]
Here is an example of job submission
sbatch ./sub.sh
Documentation
ml OrthoFinder/2.5.2-foss-2019b-Python-3.7.4 zhuofei@b1-24 ~$ orthofinder -h OrthoFinder version 2.5.2 Copyright (C) 2014 David Emms SIMPLE USAGE: Run full OrthoFinder analysis on FASTA format proteomes in <dir> orthofinder [options] -f <dir> Add new species in <dir1> to previous run in <dir2> and run new analysis orthofinder [options] -f <dir1> -b <dir2> OPTIONS: -t <int> Number of parallel sequence search threads [Default = 64] -a <int> Number of parallel analysis threads -d Input is DNA sequences -M <txt> Method for gene tree inference. Options 'dendroblast' & 'msa' [Default = dendroblast] -S <txt> Sequence search program [Default = diamond] Options: blast, diamond, diamond_ultra_sens, blast_gz, mmseqs, blast_nucl -A <txt> MSA program, requires '-M msa' [Default = mafft] Options: mafft, muscle -T <txt> Tree inference method, requires '-M msa' [Default = fasttree] Options: fasttree, raxml, raxml-ng, iqtree -s <file> User-specified rooted species tree -I <int> MCL inflation parameter [Default = 1.5] -x <file> Info for outputting results in OrthoXML format -p <dir> Write the temporary pickle files to <dir> -1 Only perform one-way sequence search -X Don't add species names to sequence IDs -y Split paralogous clades below root of a HOG into separate HOGs -z Don't trim MSAs (columns>=90% gap, min. alignment length 500) -n <txt> Name to append to the results directory -o <txt> Non-default results directory -h Print this help text WORKFLOW STOPPING OPTIONS: -op Stop after preparing input files for BLAST -og Stop after inferring orthogroups -os Stop after writing sequence files for orthogroups (requires '-M msa') -oa Stop after inferring alignments for orthogroups (requires '-M msa') -ot Stop after inferring gene trees for orthogroups WORKFLOW RESTART COMMANDS: -b <dir> Start OrthoFinder from pre-computed BLAST results in <dir> -fg <dir> Start OrthoFinder from pre-computed orthogroups in <dir> -ft <dir> Start OrthoFinder from pre-computed gene trees in <dir> LICENSE: Distributed under the GNU General Public License (GPLv3). See License.md CITATION: When publishing work that uses OrthoFinder please cite: Emms D.M. & Kelly S. (2019), Genome Biology 20:238 If you use the species tree in your work then please also cite: Emms D.M. & Kelly S. (2017), MBE 34(12): 3267-3278 Emms D.M. & Kelly S. (2018), bioRxiv https://doi.org/10.1101/267914
Installation
source code from OrthoFinder
System
64-bit Linux