Revision as of 21:11, 6 December 2019

Description

CD-HIT stands for Cluster Database at High Identity with Tolerance. The program (cd-hit) takes a fasta format sequence database as input and produces a set of 'non-redundant' (nr) representative sequences as output. In addition cd-hit outputs a cluster file, documenting the sequence 'groupies' for each nr sequence representative. The idea is to reduce the overall size of the database without removing any sequence information by only removing 'redundant' (or highly similar) sequences. This is why the resulting database is called non-redundant (nr). Essentially, cd-hit produces a set of closely related protein families from a given fasta sequence database.

Required Modules

modules documentation

Serial

cdhit

System Variables

HPC_CDHIT_DIR - installation directory
HPC_CDHIT_BIN - executable directory.
HPC_CDHIT_DOC - documentation directory.

Additional Information

OpenMP binaries have the same names as serial binaries, but have the "-omp" suffix added to their names.

Validation

Validated 4/5/2018

@@ Line 2: / Line 2: @@
 __NOEDITSECTION__
 [[Category:Software]][[Category:Bioinformatics]][[Category:Genomics]]
-<!-- ########  Template Configuration ######## -->
+{|<!--Main settings - REQUIRED-->
-<!--Edit definitions of the variables used in template calls
-Required variables:
-app - lowercase name of the application e.g. "amber"
-url - url of the software page (project, company product, etc) - e.g. "http://ambermd.org/"
-Optional variables:
-INTEL - Version of the Intel Compiler e.g. "11.1"
-MPI - MPI Implementation and version e.g. "openmpi/1.3.4"
--->
-{|
-<!--Main settings - REQUIRED-->
 |{{#vardefine:app|cdhit}}
 |{{#vardefine:url|http://weizhong-lab.ucsd.edu/cd-hit/}}
-<!--Compiler and MPI settings - OPTIONAL -->
-|{{#vardefine:intel|}} <!-- E.g. "11.1" -->
-|{{#vardefine:mpi|}} <!-- E.g. "openmpi/1.3.4" -->
-<!--Choose sections to enable - OPTIONAL-->
-|{{#vardefine:mod|1}} <!--Present instructions for running the software with modules -->
 |{{#vardefine:exe|1}} <!--Present manual instructions for running the software -->
 |{{#vardefine:conf|}} <!--Enable config wiki page link - {{#vardefine:conf|1}} = ON/conf|}} = OFF-->
@@ Line 36: / Line 21: @@
 <!--Modules-->
-{{#if: {{#var: mod}}|==Execution Environment and Modules==
+==Required Modules==
-{{App_Module|app={{#var:app}}|intel={{#var:intel}}|mpi={{#var:mpi}}}}|}}
+[[Modules|modules documentation]]
+===Serial===
+*{{#var:app}}
+==System Variables==
+* HPC_{{uc:{{#var:app}}}}_DIR - installation directory
 * HPC_CDHIT_BIN - executable directory.
 * HPC_CDHIT_DOC - documentation directory.
-To make the OpenMP version of CD-HIT available on EL5 load the following module:
+<!--Additional-->
- module load cdhitmp
+{{#if: {{#var: exe}}|==Additional Information==
-The EL6 version of CD-HIT has both serial and OpenMP binaries provided by the same module (see the note below).
-{{#if: {{#var: exe}}|==How To Run==
-WRITE INSTRUCTIONS ON RUNNING THE ACTUAL BINARY|}}
 OpenMP binaries have the same names as serial binaries, but have the "-omp" suffix added to their names.
+}}
 {{#if: {{#var: conf}}|==Configuration==
 See the [[{{PAGENAME}}_Configuration]] page for {{#var: app}} configuration details.|}}
@@ Line 60: / Line 47: @@
 WRITE CITATION HERE
 |}}
+=Validation=
+* Validated 4/5/2018

Difference between revisions of "CD-HIT"