CD-HIT-EST-2D(1)

πŸ“¦
version 4.8.1 Β· 2 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

πŸ’– CD-HIT-EST-2D πŸ’–

okay so bestie, welcome to the manual page for cd-hit-est-2d (that's section 1 of the manuals, for the record πŸ‘‘). It runs the CD-HIT algorithm on RNA/DNA sequences in db1 or db2 format. Yes, that's the whole vibe. Let's get into it πŸ’…


✨ SYNOPSIS ✨

cd-hit-est-2d [Options]

🌸 DESCRIPTION 🌸

====== CD-HIT version 4.8.1 (built on Aug 20 2021) ======

That's literally the build, no cap. Now the options, and there are a LOT of them, so buckle up πŸŽ€

πŸ¦‹ Options πŸ¦‹

  • -i β€” input filename for db1 in fasta format, required, can be in .gz format
  • -i2 β€” input filename for db2 in fasta format, required, can be in .gz format
  • -j, -j2 β€” input filename in fasta/fastq format for R2 reads if your input are paired end (PE) files
  • -i db1-R1.fq -j db1-R2.fq -i2 db2-R1.fq -j2 db2-R2.fq -o output_R1 -op output_R2 β€” or
  • -i db1-R1.fa -j db1-R2.fa -i2 db2-R1.fq -j2 db2-R2.fq -o output_R1 -op output_R2
  • -o β€” output filename, required
  • -op β€” output filename for R2 reads if your input are paired end (PE) files
  • -c β€” sequence identity threshold, default 0.9. This is the default cd-hit "global sequence identity", calculated as: number of identical amino acids or bases in alignment divided by the full length of the shorter sequence
  • -G β€” use global sequence identity, default 1. If set to 0, then use local sequence identity, calculated as: number of identical amino acids or bases in alignment divided by the length of the alignment
NOTE!!! don't use -G 0 unless you use alignment coverage controls, see options -aL, -AL, -aS, -AS
  • -b β€” band_width of alignment, default 20
  • -M β€” memory limit (in MB) for the program, default 800; 0 for unlimitted;
  • -T β€” number of threads, default 1; with 0, all CPUs will be used
  • -n β€” word_length, default 10, see user's guide for choosing it
  • -l β€” length of throw_away_sequences, default 10
  • -d β€” length of description in .clstr file, default 20. If set to 0, it takes the fasta defline and stops at first space
  • -s β€” length difference cutoff, default 0.0. If set to 0.9, the shorter sequences need to be at least 90% length of the representative of the cluster
  • -S β€” length difference cutoff in amino acid, default 999999. If set to 60, the length difference between the shorter sequences and the representative of the cluster can not be bigger than 60
  • -s2 β€” length difference cutoff for db1, default 1.0. By default, seqs in db1 >= seqs in db2 in a same cluster. If set to 0.9, seqs in db1 may just >= 90% seqs in db2
  • -S2 β€” length difference cutoff, default 0. By default, seqs in db1 >= seqs in db2 in a same cluster. If set to 60, seqs in db2 may 60aa longer than seqs in db1
  • -aL β€” alignment coverage for the longer sequence, default 0.0. If set to 0.9, the alignment must covers 90% of the sequence
  • -AL β€” alignment coverage control for the longer sequence, default 99999999. If set to 60, and the length of the sequence is 400, then the alignment must be >= 340 (400-60) residues
  • -aS β€” alignment coverage for the shorter sequence, default 0.0. If set to 0.9, the alignment must covers 90% of the sequence
  • -AS β€” alignment coverage control for the shorter sequence, default 99999999. If set to 60, and the length of the sequence is 400, then the alignment must be >= 340 (400-60) residues
  • -A β€” minimal alignment coverage control for the both sequences, default 0. Alignment must cover >= this value for both sequences
  • -uL β€” maximum unmatched percentage for the longer sequence, default 1.0. If set to 0.1, the unmatched region (excluding leading and tailing gaps) must not be more than 10% of the sequence
  • -uS β€” maximum unmatched percentage for the shorter sequence, default 1.0. If set to 0.1, the unmatched region (excluding leading and tailing gaps) must not be more than 10% of the sequence
  • -U β€” maximum unmatched length, default 99999999. If set to 10, the unmatched region (excluding leading and tailing gaps) must not be more than 10 bases
  • -B β€” 1 or 0, default 0. By default, sequences are stored in RAM. If set to 1, sequence are stored on hard drive
!! No longer supported !! πŸ’€
  • -P β€” input paired end (PE) reads, default 0, single file. If set to 1, please use -i R1 -j R2 to input both PE files
  • -cx β€” length to keep after trimming the tail of sequence, default 0, not trimming. If set to 50, the program only uses the first 50 letters of input sequence
  • -cy β€” length to keep after trimming the tail of R2 sequence, default 0, not trimming. If set to 50, the program only uses the first 50 letters of input R2 sequence, e.g. -cx 100 -cy 80 for paired end reads
  • -p β€” 1 or 0, default 0. If set to 1, print alignment overlap in .clstr file
  • -g β€” 1 or 0, default 0. By cd-hit's default algorithm, a sequence is clustered to the first cluster that meet the threshold (fast cluster). If set to 1, the program will cluster it into the most similar cluster that meet the threshold (accurate but slow mode), but either 1 or 0 won't change the representatives of final clusters
  • -r β€” 1 or 0, default 1. By default do both +/+ & +/- alignments. If set to 0, only +/+ strand alignment
  • -mask β€” masking letters (e.g. -mask NX, to mask out both 'N' and 'X')
  • -match β€” matching score, default 2 (1 for T-U and N-N)
  • -mismatch β€” mismatching score, default -2
  • -gap β€” gap opening score, default -6
  • -gap-ext β€” gap extension score, default -1
  • -bak β€” write backup cluster file (1 or 0, default 0)
  • -h β€” print this help

πŸ’Œ Questions, bugs, contact πŸ’Œ

Got questions? Bugs? Wanna slide into the DMs? Contact Weizhong Li at liwz@sdsc.edu 🫢

For updated versions and information, please visit: http://cd-hit.org

or https://github.com/weizhongli/cdhit

The cd-hit web server is also available from http://cd-hit.org ✨

If you find cd-hit useful, please kindly cite:

"CD-HIT: a fast program for clustering and comparing large sets of protein or nucleotide sequences", Weizhong Li & Adam Godzik. Bioinformatics, (2006) 22:1658-1659
"CD-HIT: accelerated for clustering the next generation sequencing data", Limin Fu, Beifang Niu, Zhengwei Zhu, Sitao Wu & Weizhong Li. Bioinformatics, (2012) 28:3150-3152

and that's the whole page bestie πŸŽ€ cd-hit-est-2d is sitting at version 4.8.1, this manual page is dated August 2021, and you just read CD-HIT-EST-2D(1). slay, go cluster something πŸ’…βœ¨πŸ‘‘

πŸ“¦ where this page comes from