SUMACLUST(1)

πŸ’– SUMACLUST πŸ’–

okay bestie, so sumaclust is the manual page we're doing today β€” it lives in section 1 (User Commands) and it's literally a star clustering tool for genetic sequences ✨


🌟 NAME 🌟

sumaclust β€” star clustering of genetic sequences πŸ¦‹


πŸŽ€ SYNOPSIS πŸŽ€

sumaclust [options] <dataset>

✨ DESCRIPTION ✨

so with next-gen sequencing popping off, we need tools that can handle millions of sequences in a reasonable amount of time, and that's exactly what this is, no cap. Sumaclust is a program developed by the LECA πŸ’œ and its whole thing is clustering sequences in a way that's fast AND exact at the same time β€” like, both. icon behaviour honestly.

It was built to be adapted to the type of data that DNA metabarcoding generates, i.e. entirely sequenced, short markers 🧬. And it clusters sequences using the same clustering algorithm as UCLUST and CD-HIT. This algorithm is mainly useful for detecting the 'erroneous' sequences that get created during amplification and sequencing protocols β€” you know, the ones deriving from the 'true' sequences. it's giving cleanup crew πŸ’…


πŸ’… OPTIONS πŸ’…

  • -h β€” [H]elp, bestie. prints <this> help 🫢
  • -l β€” Reference sequence length is the shortest.
  • -L β€” Reference sequence length is the largest.
  • -a β€” Reference sequence length is the alignment length (default).
  • -n β€” Score is normalized by reference sequence length (default).
  • -r β€” Raw score, not normalized.
  • -d β€” Score is expressed in distance (default : score is expressed in similarity).
  • -t ##.## β€” Score threshold for clustering. And okay, this one has lore, so listen up:
    • If the score is normalized and expressed in similarity (which is the default), then it's an identity β€” e.g. 0.95 for an identity of 95%.
    • If the score is normalized and expressed in distance, it's (1.0 - identity) β€” e.g. 0.05 for an identity of 95%.
    • If the score is not normalized and expressed in similarity, it's the length of the Longest Common Subsequence.
    • If the score is not normalized and expressed in distance, it's (reference length - LCS length).
    • Only sequences with a similarity above ##.## with the center sequence of a cluster get assigned to that cluster. Default: 0.97. πŸ‘‘
  • -e β€” Exact option ✨ A sequence is assigned to the cluster whose center sequence presents the highest similarity score > threshold. This is the opposite of the default 'fast' option, where a sequence is assigned to the first cluster found with a center sequence presenting a score > threshold.
  • -R ## β€” Maximum ratio between the counts of two sequences so that the less abundant one can be considered as a variant of the more abundant one. Default: 1.0.
  • -p ## β€” Multithreading with ## threads using openMP πŸ”₯
  • -s #### β€” Sorting by ####. Must be 'None' for no sorting, or a key in the fasta header of each sequence β€” except for the count, which can be computed (default : sorting by count).
  • -o β€” Sorting is in ascending order (default : descending).
  • -g β€” n's are replaced with a's (default: sequences with n's are discarded). πŸ™ˆ
  • -B ### β€” Output of the OTU table in BIOM format is activated, and written to file ###.
  • -O ### β€” Output of the OTU map (observation map) is activated, and written to file ###.
  • -F ### β€” Output in FASTA format is written to file ### instead of standard output.
  • -f β€” Output in FASTA format is deactivated.

Argument : the nucleotide dataset to cluster 🧬


🌈 SEE ALSO 🌈

http://metabarcoding.org/sumatra


and that's the whole page, bestie πŸŽ€ this was sumaclust version 1.0.10, dated August 2015 β€” literally a classic, we stan a vintage icon πŸ’–βœ¨πŸ¦‹