DIAMOND(1)

๐Ÿ’– DIAMOND(1) ๐Ÿ’–

okay bestie, welcome to the DIAMOND(1) manual page โ€” this is literally the whole vibe for diamond, the accelerated BLAST compatible local sequence aligner. no cap, we're gonna go through every flag, every command, every lil keyword, and you're gonna understand it. periodt. ๐Ÿ’…โœจ


โœจ NAME โœจ

  • diamond โ€” accelerated BLAST compatible local sequence aligner ๐Ÿฆ‹

๐Ÿ’– DESCRIPTION ๐Ÿ’–

so first things first, the version is diamond v2.0.13.151, and the copyright is (C) Max Planck Society for the Advancement of Science. Documentation, support and updates are available at http://www.diamondsearch.org. Please cite: http://dx.doi.org/10.1038/s41592-021-01101-x โ€” that's Nature Methods (2021). iconic. ๐Ÿ“โœจ

Syntax:

diamond COMMAND [OPTIONS]

๐ŸŒˆ Commands ๐ŸŒˆ

  • makedb โ€” Build DIAMOND database from a FASTA file ๐Ÿ—‚๏ธ
  • blastp โ€” Align amino acid query sequences against a protein reference database ๐Ÿงฌ
  • blastx โ€” Align DNA query sequences against a protein reference database ๐Ÿงฌ
  • view โ€” View DIAMOND alignment archive (DAA) formatted file ๐Ÿ‘€
  • help โ€” Produce help message ๐Ÿ†˜
  • version โ€” Display version information ๐Ÿ“Œ
  • getseq โ€” Retrieve sequences from a DIAMOND database file ๐Ÿ“ฅ
  • dbinfo โ€” Print information about a DIAMOND database file โ„น๏ธ
  • test โ€” Run regression tests ๐Ÿงช
  • makeidx โ€” Make database index ๐Ÿ—‚๏ธ

๐ŸŒธ General options ๐ŸŒธ

  • --threads (-p) โ€” number of CPU threads ๐Ÿงต
  • --db (-d) โ€” database file ๐Ÿ—„๏ธ
  • --out (-o) โ€” output file ๐Ÿ“ค
  • --outfmt (-f) โ€” output format ๐Ÿ“‹

output format values

  • 0 = BLAST pairwise
  • 5 = BLAST XML
  • 6 = BLAST tabular
  • 100 = DIAMOND alignment archive (DAA)
  • 101 = SAM

Value 6 may be followed by a space-separated list of these keywords:

  • qseqid means Query Seq - id
  • qlen means Query sequence length
  • sseqid means Subject Seq - id
  • sallseqid means All subject Seq - id(s), separated by a ;
  • slen means Subject sequence length
  • qstart means Start of alignment in query
  • qend means End of alignment in query
  • sstart means Start of alignment in subject
  • send means End of alignment in subject
  • qseq means Aligned part of query sequence
  • qseq_translated means Aligned part of query sequence (translated)
  • full_qseq means Query sequence
  • full_qseq_mate means Query sequence of the mate
  • sseq means Aligned part of subject sequence
  • full_sseq means Subject sequence
  • evalue means Expect value
  • bitscore means Bit score
  • score means Raw score
  • length means Alignment length
  • pident means Percentage of identical matches
  • nident means Number of identical matches
  • mismatch means Number of mismatches
  • positive means Number of positive - scoring matches
  • gapopen means Number of gap openings
  • gaps means Total number of gaps
  • ppos means Percentage of positive - scoring matches
  • qframe means Query frame
  • btop means Blast traceback operations(BTOP)
  • cigar means CIGAR string
  • staxids means unique Subject Taxonomy ID(s), separated by a ; (in numerical order)
  • sscinames means unique Subject Scientific Name(s), separated by a ;
  • sskingdoms means unique Subject Super Kingdom(s), separated by a ;
  • skingdoms means unique Subject Kingdom(s), separated by a ;
  • sphylums means unique Subject Phylum(s), separated by a ;
  • stitle means Subject Title
  • salltitles means All Subject Title(s), separated by a <>
  • qcovhsp means Query Coverage Per HSP
  • scovhsp means Subject Coverage Per HSP
  • qtitle means Query title
  • qqual means Query quality values for the aligned part of the query
  • full_qqual means Query quality values
  • qstrand means Query strand

Default: qseqid sseqid pident length mismatch gapopen qstart qend sstart send evalue bitscore

  • --verbose (-v) โ€” verbose console output ๐Ÿ”Š
  • --log โ€” enable debug log ๐Ÿ“
  • --quiet โ€” disable console output ๐Ÿคซ
  • --header โ€” Write header lines to blast tabular format. ๐Ÿ“‹

๐Ÿ—‚๏ธ Makedb options ๐Ÿ—‚๏ธ

  • --in โ€” input reference file in FASTA format ๐Ÿ“ฅ
  • --taxonmap โ€” protein accession to taxid mapping file ๐Ÿงฌ
  • --taxonnodes โ€” taxonomy nodes.dmp from NCBI ๐ŸŒณ
  • --taxonnames โ€” taxonomy names.dmp from NCBI ๐ŸŒณ

๐Ÿงฌ Aligner options ๐Ÿงฌ

  • --query (-q) โ€” input query file ๐Ÿ“ฅ
  • --strand โ€” query strands to search (both/minus/plus) ๐Ÿงญ
  • --un โ€” file for unaligned queries ๐Ÿ“„
  • --al โ€” file or aligned queries ๐Ÿ“„
  • --unfmt โ€” format of unaligned query file (fasta/fastq) ๐Ÿ“„
  • --alfmt โ€” format of aligned query file (fasta/fastq) ๐Ÿ“„
  • --unal โ€” report unaligned queries (0=no, 1=yes) ๐Ÿ“Š
  • --max-target-seqs (-k) โ€” maximum number of target sequences to report alignments for (default=25) ๐ŸŽฏ
  • --top โ€” report alignments within this percentage range of top alignment score (overrides --max-target-seqs) ๐Ÿ†
  • --max-hsps โ€” maximum number of HSPs per target sequence to report for each query (default=1) ๐Ÿ”ข
  • --range-culling โ€” restrict hit culling to overlapping query ranges โœ‚๏ธ
  • --compress โ€” compression for output files (0=none, 1=gzip, zstd) ๐Ÿ—œ๏ธ
  • --evalue (-e) โ€” maximum e-value to report alignments (default=0.001) ๐Ÿ“‰
  • --min-score โ€” minimum bit score to report alignments (overrides e-value setting) ๐Ÿ“ˆ
  • --id โ€” minimum identity% to report an alignment ๐Ÿ†”
  • --query-cover โ€” minimum query cover% to report an alignment ๐Ÿ“
  • --subject-cover โ€” minimum subject cover% to report an alignment ๐Ÿ“
  • --fast โ€” enable fast mode โšก
  • --mid-sensitive โ€” enable mid-sensitive mode โš–๏ธ
  • --sensitive โ€” enable sensitive mode ๐ŸŽฏ
  • --more-sensitive โ€” enable more sensitive mode ๐ŸŽฏ
  • --very-sensitive โ€” enable very sensitive mode ๐ŸŽฏ
  • --ultra-sensitive โ€” enable ultra sensitive mode ๐ŸŽฏ
  • --iterate โ€” iterated search with increasing sensitivity ๐Ÿ”
  • --global-ranking (-g) โ€” number of targets for global ranking ๐ŸŒ
  • --block-size (-b) โ€” sequence block size in billions of letters (default=2.0) ๐Ÿงฑ
  • --index-chunks (-c) โ€” number of chunks for index processing (default=4) ๐Ÿงฉ
  • --tmpdir (-t) โ€” directory for temporary files ๐Ÿ“
  • --parallel-tmpdir โ€” directory for temporary files used by multiprocessing ๐Ÿ“
  • --gapopen โ€” gap open penalty โœ‚๏ธ
  • --gapextend โ€” gap extension penalty โœ‚๏ธ
  • --frameshift (-F) โ€” frame shift penalty (default=disabled) ๐Ÿšซ
  • --long-reads โ€” short for --range-culling --top 10 -F 15 ๐Ÿ“š
  • --matrix โ€” score matrix for protein alignment (default=BLOSUM62) ๐Ÿงฎ
  • --custom-matrix โ€” file containing custom scoring matrix ๐Ÿงฎ
  • --comp-based-stats โ€” composition based statistics mode (0-4) ๐Ÿ“Š
  • --masking โ€” masking algorithm (none, seg, tantan=default) ๐ŸŽญ
  • --query-gencode โ€” genetic code to use to translate query (see user manual) ๐Ÿงฌ
  • --salltitles โ€” include full subject titles in DAA file ๐Ÿ“
  • --sallseqid โ€” include all subject ids in DAA file ๐Ÿ†”
  • --no-self-hits โ€” suppress reporting of identical self hits ๐Ÿšซ
  • --taxonlist โ€” restrict search to list of taxon ids (comma-separated) ๐Ÿ“‹
  • --taxon-exclude โ€” exclude list of taxon ids (comma-separated) ๐Ÿšซ
  • --seqidlist โ€” filter the database by list of accessions ๐Ÿ—‚๏ธ
  • --skip-missing-seqids โ€” ignore accessions missing in the database ๐Ÿšซ

๐Ÿ”ฅ Advanced options ๐Ÿ”ฅ

  • --algo โ€” Seed search algorithm (0=double-indexed/1=query-indexed/ctg=contiguous-seed) ๐Ÿง 
  • --bin โ€” number of query bins for seed search ๐Ÿ—ƒ๏ธ
  • --min-orf (-l) โ€” ignore translated sequences without an open reading frame of at least this length ๐Ÿ“
  • --seed-cut โ€” cutoff for seed complexity โœ‚๏ธ
  • --freq-masking โ€” mask seeds based on frequency ๐ŸŽญ
  • --freq-sd โ€” number of standard deviations for ignoring frequent seeds ๐Ÿ“Š
  • --motif-masking โ€” softmask abundant motifs (0/1) ๐ŸŽญ
  • --id2 โ€” minimum number of identities for stage 1 hit ๐Ÿ†”
  • --xdrop (-x) โ€” xdrop for ungapped alignment ๐Ÿ“‰
  • --gapped-filter-evalue โ€” E-value threshold for gapped filter (auto) ๐Ÿ“‰
  • --band โ€” band for dynamic programming computation ๐ŸŽต
  • --shapes (-s) โ€” number of seed shapes (default=all available) ๐Ÿ”ท
  • --shape-mask โ€” seed shapes ๐Ÿ”ท
  • --multiprocessing โ€” enable distributed-memory parallel processing ๐Ÿ–ฅ๏ธ
  • --mp-init โ€” initialize multiprocessing run ๐Ÿš€
  • --mp-recover โ€” enable continuation of interrupted multiprocessing run ๐Ÿ”„
  • --mp-query-chunk โ€” process only a single query chunk as specified ๐Ÿงฉ
  • --ext-chunk-size โ€” chunk size for adaptive ranking (default=auto) ๐Ÿ“ฆ
  • --no-ranking โ€” disable ranking heuristic ๐Ÿšซ
  • --ext โ€” Extension mode (banded-fast/banded-slow/full) ๐Ÿงช
  • --culling-overlap โ€” minimum range overlap with higher scoring hit to delete a hit (default=50%) โœ‚๏ธ
  • --taxon-k โ€” maximum number of targets to report per species ๐Ÿงฌ
  • --range-cover โ€” percentage of query range to be covered for range culling (default=50%) ๐Ÿ“
  • --dbsize โ€” effective database size (in letters) ๐Ÿ—„๏ธ
  • --no-auto-append โ€” disable auto appending of DAA and DMND file extensions ๐Ÿšซ
  • --xml-blord-format โ€” Use gnl|BL_ORD_ID| style format in XML output ๐Ÿ“„
  • --stop-match-score โ€” Set the match score of stop codons against each other. ๐Ÿ›‘
  • --tantan-minMaskProb โ€” minimum repeat probability for masking (default=0.9) ๐ŸŽญ
  • --file-buffer-size โ€” file buffer size in bytes (default=67108864) ๐Ÿ“ฆ
  • --memory-limit (-M) โ€” Memory limit for extension stage in GB ๐Ÿง 
  • --no-unlink โ€” Do not unlink temporary files. ๐Ÿšซ
  • --target-indexed โ€” Enable target-indexed mode ๐ŸŽฏ
  • --ignore-warnings โ€” Ignore warnings โš ๏ธ

๐Ÿ‘€ View options ๐Ÿ‘€

  • --daa (-a) โ€” DIAMOND alignment archive (DAA) file ๐Ÿ“ฆ
  • --forwardonly โ€” only show alignments of forward strand โžก๏ธ

๐Ÿ“ฅ Getseq options ๐Ÿ“ฅ

  • --seq โ€” Space-separated list of sequence numbers to display. ๐Ÿ”ข

Online documentation at http://www.diamondsearch.org ๐ŸŒ


๐Ÿ‘‘ AUTHOR ๐Ÿ‘‘

This manpage was written by Nilesh Patra for the Debian distribution and can be used for any other usage of the program. slay. ๐Ÿ’…


so yeah, that's the whole page. the footer says diamond 2.0.13, October 2021, DIAMOND(1) โ€” mwah ๐Ÿ’‹โœจ