SPADES(1)

πŸ“¦
version 3.15.5 Β· 4 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

πŸ’– SPADES β€” bestie's guide to the SPAdes genome assembler πŸ’–

okay so. you found spades, the manual page, and honestly? iconic. this is the main character executable of the whole SPAdes software situation. it takes your genomic reads, assembles them, and drops the resulting assembly into <output_dir>. no cap. let's go 🧚✨


🌸 SYNOPSIS 🌸

spades [options] -o <output_dir>

that's it. that's the whole vibe. options in, output dir out. πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

spades is the main executable for the SPAdes software, fr fr. it assembles the genomic reads you hand it and places the resulting assembly in <output_dir>. like a little assembly fairy but make it bioinformatics 🧬✨


✨ OPTIONS ✨

πŸŽ€ Basic options

  • -o <output_dir> β€” the directory where all the resulting files go. this one is required, bestie, don't skip it πŸ™ˆ
  • --sc β€” this flag is required for MDA (single-cell) data πŸ‘‘
  • --meta β€” this flag is required for metagenomic sample data 🦠
  • --rna β€” this flag is required for RNA-seq data 🧬
  • --plasmid β€” runs the plasmidSPAdes pipeline for plasmid detection πŸ’«
  • --iontorrent β€” this flag is required for IonTorrent data ⚑
  • --test β€” runs SPAdes on a toy dataset 🧸 (yes, toy. adorable.)
  • -h/--help β€” prints this usage message. hi, hello, welcome πŸ’–

🌈 Input data

  • --12 <filename> β€” file with interlaced forward and reverse paired-end reads
  • -1 <filename> β€” file with forward paired-end reads
  • -2 <filename> β€” file with reverse paired-end reads
  • -s <filename> β€” file with unpaired reads
  • --pe<#>-12 <filename> β€” file with interlaced reads for paired-end library number <#> (<#> = 1,2,3,4,5)
  • --pe<#>-1 <filename> β€” file with forward reads for paired-end library number <#> (<#> = 1,2,3,4,5)
  • --pe<#>-2 <filename> β€” file with reverse reads for paired-end library number <#> (<#> = 1,2,3,4,5)
  • --pe<#>-s <filename> β€” file with unpaired reads for paired-end library number <#> (<#> = 1,2,3,4,5)
  • --pe<#>-<or> β€” orientation of reads for paired-end library number <#> (<#> = 1,2,3,4,5; <or> = fr, rf, ff)
  • --s<#> <filename> β€” file with unpaired reads for single reads library number <#> (<#> = 1,2,3,4,5)
  • --mp<#>-12 <filename> β€” file with interlaced reads for mate-pair library number <#> (<#> = 1,2,3,4,5)
  • --mp<#>-1 <filename> β€” file with forward reads for mate-pair library number <#> (<#> = 1,2,3,4,5)
  • --mp<#>-2 <filename> β€” file with reverse reads for mate-pair library number <#> (<#> = 1,2,3,4,5)
  • --mp<#>-s <filename> β€” file with unpaired reads for mate-pair library number <#> (<#> = 1,2,3,4,5)
  • --mp<#>-<or> β€” orientation of reads for mate-pair library number <#> (<#> = 1,2,3,4,5; <or> = fr, rf, ff)
  • --hqmp<#>-12 <filename> β€” file with interlaced reads for high-quality mate-pair library number <#> (<#> = 1,2,3,4,5)
  • --hqmp<#>-1 <filename> β€” file with forward reads for high-quality mate-pair library number <#> (<#> = 1,2,3,4,5)
  • --hqmp<#>-2 <filename> β€” file with reverse reads for high-quality mate-pair library number <#> (<#> = 1,2,3,4,5)
  • --hqmp<#>-s <filename> β€” file with unpaired reads for high-quality mate-pair library number <#> (<#> = 1,2,3,4,5)
  • --hqmp<#>-<or> β€” orientation of reads for high-quality mate-pair library number <#> (<#> = 1,2,3,4,5; <or> = fr, rf, ff)
  • --nxmate<#>-1 <filename> β€” file with forward reads for Lucigen NxMate library number <#> (<#> = 1,2,3,4,5)
  • --nxmate<#>-2 <filename> β€” file with reverse reads for Lucigen NxMate library number <#> (<#> = 1,2,3,4,5)
  • --sanger <filename> β€” file with Sanger reads
  • --pacbio <filename> β€” file with PacBio reads
  • --nanopore <filename> β€” file with Nanopore reads
  • --trusted-contigs <filename> β€” file with trusted contigs 🫢
  • --untrusted-contigs <filename> β€” file with untrusted contigs πŸ™ˆ

πŸ’œ Pipeline options

  • --only-error-correction β€” runs only read error correction (no assembling, just the correction era of the pipeline)
  • --only-assembler β€” runs only assembling (no read error correction)
  • --careful β€” tries to reduce the number of mismatches and short indels 🎯
  • --continue β€” continue the run from the last available check-point πŸƒβ™€οΈ
  • --restart-from <cp> β€” restart the run with updated options and from the specified check-point ('ec', 'as', 'k<int>', 'mc')
  • --disable-gzip-output β€” forces error correction not to compress the corrected reads
  • --disable-rr β€” disables the repeat resolution stage of assembling

⭐ Advanced options

  • --dataset <filename> β€” file with dataset description in YAML format πŸ“„
  • -t/--threads <int> β€” number of threads [default: 16]
  • -m/--memory <int> β€” RAM limit for SPAdes in Gb. if you exceed it, it terminates. not a drill πŸ’€ [default: 250]
  • --tmp-dir <dirname> β€” directory for temporary files [default: <output_dir>/tmp]
  • -k <int,int,...> β€” comma-separated list of k-mer sizes. must be odd and less than 128, lowkey important πŸ”₯ [default: 'auto']
  • --cov-cutoff <float> β€” coverage cutoff value (a positive float number, or 'auto', or 'off') [default: 'off']
  • --phred-offset <33 or 64> β€” PHRED quality offset in the input reads (33 or 64) [default: auto-detect] πŸ‘€

ngl bestie, double-check your flags before you hit enter. a wrong library number or a missing -o will have you sitting there confused and that's not the energy we're bringing today πŸ™ˆπŸ’…

that's the whole page, periodt. πŸŽ€ this was the SPADES(1) manual, and the footer is just more SPADES(1) energy β€” no version number or date dropped on this one, so that's literally all she wrote. go assemble something gorgeous, bestie, you got this πŸ¦‹πŸ’–βœ¨

πŸ“¦ where this page comes from