Difference between revisions of "OrthoMCL"

From UFRC
Jump to navigation Jump to search
Line 11: Line 11:
 
|{{#vardefine:testing|}} <!--Enable performance testing/profiling section -->
 
|{{#vardefine:testing|}} <!--Enable performance testing/profiling section -->
 
|{{#vardefine:faq|}} <!--Enable FAQ section -->
 
|{{#vardefine:faq|}} <!--Enable FAQ section -->
|{{#vardefine:citation|}} <!--Enable Reference/Citation section -->
+
|{{#vardefine:citation|1}} <!--Enable Reference/Citation section -->
 
|}
 
|}
 
<!-- ########  Template Body ######## -->
 
<!-- ########  Template Body ######## -->
Line 31: Line 31:
 
{{#if: {{#var: exe}}|==How To Run==
 
{{#if: {{#var: exe}}|==How To Run==
 
For a given OrthoMCL version the /apps/orthomcl/VERSION/config/orthomcl.config file provides a template for configuring an OrthoMCL database. Change the database name from 'orthomcl', which is an existing database containing the data from OrthoMCL authors to your own database that has a name with a pattern <code>'project_user_orthomcl'</code> in the string <code>'dbConnectString=dbi:mysql:'''orthomcl''':10.13.20.209'</code>. MySQL server will allow the orthomcl user to create databases with that name pattern.
 
For a given OrthoMCL version the /apps/orthomcl/VERSION/config/orthomcl.config file provides a template for configuring an OrthoMCL database. Change the database name from 'orthomcl', which is an existing database containing the data from OrthoMCL authors to your own database that has a name with a pattern <code>'project_user_orthomcl'</code> in the string <code>'dbConnectString=dbi:mysql:'''orthomcl''':10.13.20.209'</code>. MySQL server will allow the orthomcl user to create databases with that name pattern.
 +
 +
OrthoMCL documentation is available from several sources.
 +
 +
* A User Guide and other documents in text format are located in /apps/orthomcl/VERSION/doc/OrthoMCLEngine/Main/ and at [http://orthomcl.org/common/downloads/software/v2.0/UserGuide.txt].
 +
 +
* An alternative User Guide can be found at [http://onlinelibrary.wiley.com/doi/10.1002/0471250953.bi0612s35/full Wiley Online Library].
 +
 +
* The original publications that describe the functionality of the software are [http://dx.doi.org/10.1101%2Fgr.1224503 10.1101/gr.1224503] and [http://dx.doi.org/10.1093%2Fnar%2Fgkj123 10.1093/nar/gkj123].
 
|}}
 
|}}
 
{{#if: {{#var: conf}}|==Configuration==
 
{{#if: {{#var: conf}}|==Configuration==
Line 43: Line 51:
 
*'''Q:''' **'''A:'''|}}
 
*'''Q:''' **'''A:'''|}}
 
{{#if: {{#var: citation}}|==Citation==
 
{{#if: {{#var: citation}}|==Citation==
If you publish research that uses {{{app}}} you have to cite it as follows:
+
If you publish research that uses {{#var: app}} you have to cite it as follows:
WRITE CITATION HERE
+
#Feng Chen, Aaron J. Mackey, Christian J. Stoeckert, Jr., and David S. Roos. OrthoMCL-DB: querying a comprehensive multi-species collection of ortholog groups. Nucleic Acids Res. 2006 34: D363-8. '''Please cite this paper if you publish research results benefited from OrthoMCL-DB.'''
 +
#Li Li, Christian J. Stoeckert, Jr., and David S. Roos.  OrthoMCL: Identification of Ortholog Groups for Eukaryotic Genomes. Genome Res. 2003 13: 2178-2189.
 +
#Feng Chen, Aaron J. Mackey, Jeroen K. Vermunt, and David S. Roos. Assessing Performance of Orthology Detection Strategies Applied to Eukaryotic Genomes. PLoS ONE 2007 2(4): e383.
 
|}}
 
|}}

Revision as of 20:46, 15 April 2013

Description

orthomcl website  

OrthoMCL is a genome-scale algorithm for grouping orthologous protein sequences. It provides not only groups shared by two or more species/genomes, but also groups representing species-specific gene expansion families. So it serves as an important utility for automated eukaryotic genome annotation. OrthoMCL starts with reciprocal best hits within each genome as potential in-paralog/recent paralog pairs and reciprocal best hits across any two genomes as potential ortholog pairs. Related proteins are interlinked in a similarity graph. Then MCL (Markov Clustering algorithm,Van Dongen 2000; www.micans.org/mcl) is invoked to split mega-clusters. This process is analogous to the manual review in COG construction. MCL clustering is based on weights between each pair of proteins, so to correct for differences in evolutionary distance the weights are normalized before running MCL.

Required Modules

modules documentation

Serial

  • orthomcl

System Variables

  • HPC_{{#uppercase:orthomcl}}_DIR - installation directory
  • HPC_ORTHOMCL_BIN - executable directory
  • HPC_ORTHOMCL_CONF - configuration directory. It contains the orthomcl.config file that provides the MySQL connection settings, credentials, and the database structure.

How To Run

For a given OrthoMCL version the /apps/orthomcl/VERSION/config/orthomcl.config file provides a template for configuring an OrthoMCL database. Change the database name from 'orthomcl', which is an existing database containing the data from OrthoMCL authors to your own database that has a name with a pattern 'project_user_orthomcl' in the string 'dbConnectString=dbi:mysql:orthomcl:10.13.20.209'. MySQL server will allow the orthomcl user to create databases with that name pattern.

OrthoMCL documentation is available from several sources.

  • A User Guide and other documents in text format are located in /apps/orthomcl/VERSION/doc/OrthoMCLEngine/Main/ and at [1].



Citation

If you publish research that uses orthomcl you have to cite it as follows:

  1. Feng Chen, Aaron J. Mackey, Christian J. Stoeckert, Jr., and David S. Roos. OrthoMCL-DB: querying a comprehensive multi-species collection of ortholog groups. Nucleic Acids Res. 2006 34: D363-8. Please cite this paper if you publish research results benefited from OrthoMCL-DB.
  2. Li Li, Christian J. Stoeckert, Jr., and David S. Roos. OrthoMCL: Identification of Ortholog Groups for Eukaryotic Genomes. Genome Res. 2003 13: 2178-2189.
  3. Feng Chen, Aaron J. Mackey, Jeroen K. Vermunt, and David S. Roos. Assessing Performance of Orthology Detection Strategies Applied to Eukaryotic Genomes. PLoS ONE 2007 2(4): e383.