[{"_1":2,"_163":-5,"_164":-5},"loaderData",{"_3":4,"_18":19,"_26":27,"_142":143},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16,"_17":11},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","dockerRebrandTour","routes/_layout",{"_20":-5,"_21":22,"_23":22,"_24":11,"_25":22},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_28":29,"_30":-5,"_31":11,"_32":11,"_33":34,"_35":36,"_37":-5,"_38":11,"_39":40,"_89":-5,"_90":91,"_130":-5,"_131":11,"_132":22,"_133":11,"_134":11,"_135":-5,"_136":11,"_137":-5,"_138":139,"_140":92,"_141":-7},"canonicalUrl","https://hub.docker.com/r/annacprice/ppbedtools/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","annacprice","reponame","ppbedtools","cloudBuildSource","isAutobuildsAvailable","repo",{"_41":42,"_43":44,"_46":47,"_48":49,"_50":11,"_51":52,"_53":54,"_55":56,"_58":36,"_33":34,"_59":60,"_61":45,"_62":63,"_64":65,"_66":67,"_68":-5,"_69":63,"_70":71,"_72":11,"_73":34,"_74":75,"_80":11,"_81":82,"_86":34,"_87":88},"categories",[],"content_types",[45],"image","date_registered","2021-03-23T15:58:14.832599Z","description","bedtools container for the preprocessing workflow","is_private","last_updated","2021-05-12T19:39:19.952175Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[57],"application/vnd.docker.container.image.v1+json","name","pull_count",250,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Mycobacterial Pre-processing Pipeline #\n \nCleans and QCs reads with fastp and FastQC, classifies with Kraken2 & Mykrobe, removes non-bacterial content, and - by alignment to any minority genomes - disambiguates mixtures of bacterial reads.\n\nTakes as input one directory containing pairs of fastq(.gz) or bam files.\nProduces as output one directory per sample, containing the relevant reports & a pair of cleaned fastqs.\n\n## Quick Start ## \nThe workflow is designed to run with either docker `-profile docker` or singularity `-profile singularity`. Before running the workflow using singularity, the singularity images for the workflow will need to be built by running `singularity/singularity_pull.sh` \n\nE.g. to run the workflow:\n```\nnextflow run main.nf -profile singularity --filetype fastq --input_dir fq_dir --pattern \"*_R{1,2}.fastq.gz\" --unmix_myco yes \\\n--output_dir . --kraken_db /path/to/database --bowtie2_index /path/to/index --bowtie_index_name hg19_1kgmaj\n\nnextflow run main.nf -profile docker --filetype bam --input_dir bam_dir --unmix_myco no \\\n--output_dir . --kraken_db /path/to/database --bowtie2_index /path/to/index --bowtie_index_name hg19_1kgmaj\n```\n\n## Params ##\nThe following parameters should be set in `nextflow.config` or specified on the command line:\n\n* **input_dir**
\nDirectory containing fastq OR bam files\n* **filetype**
\nFile type in input_dir. Either \"fastq\" or \"bam\"\n* **pattern**
\nRegex to match fastq files in input_dir, e.g. \"*_R{1,2}.fq.gz\"\n* **output_dir**
\nOutput directory\n* **unmix_myco**
\nDo you want to disambiguate mixed-mycobacterial samples by read alignment? Either \"yes\" or \"no\"\n* **species**
\nPrincipal species in each sample, assuming genus Mycobacterium. Default 'null'. If parameter used, takes 1 of 10 values: abscessus, africanum, avium, bovis, chelonae, chimaera, fortuitum, intracellulare, kansasii, tuberculosis\n* **kraken_db**
\nDirectory containing `*.k2d` Kraken2 database files (obtain from https://benlangmead.github.io/aws-indexes/k2)\n* **bowtie2_index**
\nDirectory containing Bowtie2 index (obtain from ftp://ftp.ccb.jhu.edu/pub/data/bowtie2_indexes/hg19_1kgmaj_bt2.zip). The specified path should NOT include the index name\n* **bowtie_index_name**
\nName of the bowtie index, e.g. hg19_1kgmaj
\n
\n\nFor more information on the parameters run `nextflow run main.nf --help`\n\n## Checkpoints ##\nCheckpoints used throughout this workflow to fail a sample/issue warnings:\n \n processes preprocessing_checkFqValidity or preprocessing_checkBamValidity\n 1. (Fail) If sample does not pass fqtools 'validate' or samtools 'quickcheck', as appropriate.\n \n process preprocessing_countReads\\\n 2. (Fail) If sample contains < 100k pairs of raw reads.\n \n process preprocessing_fastp\\\n 3. (Fail) If sample contains < 100k pairs of cleaned reads, required to all be > 50bp (cleaning using fastp with --length_required 50 --average_qual 10 --low_complexity_filter --correction --cut_right --cut_tail --cut_tail_window_size 1 --cut_tail_mean_quality 20).\n\n process preprocessing_kraken2\\\n 4. (Fail) If the top family hit is not Mycobacteriaceae\\\n 5. (Fail) If there are fewer than 100k reads classified as Mycobacteriaceae \\\n 6. (Warn) If the top family classification is mycobacterial, but this is not consistent with top genus and species classifications\\\n 7. (Warn) If the top family is Mycobacteriaceae but no G1 (species complex) classifications meet minimum thresholds of > 5000 reads or > 0.5% of the total reads (this is not necessarily a concern as not all mycobacteria have a taxonomic classification at this rank) \\\n 8. (Warn) If sample is mixed or contaminated - defined as containing reads > the 5000/0.5% thresholds from multiple non-human species\\\n 9. (Warn) If sample contains multiple classifications to mycobacterial species complexes, each meeting the > 5000/0.5% thresholds\\\n 10. (Warn) If no species classification meets the 5000/0.5% thresholds\\\n 11. (Warn) If no genus classification meets the 5000/0.5% thresholds\\\n 12. (Fail) If no family classification meets the 5000/0.5% thresholds (redundant given point 5)\n \n process preprocessing_identifyBacterialContaminants\\\n 13. (Fail) If the sample is not contaminated and the top species hit is not one of the 10 supported Mycobacteria:\\ abscessus|africanum|avium|bovis|chelonae|chimaera|fortuitum|intracellulare|kansasii|tuberculosis\\\n 14. (Fail) If the sample is not contaminated and the top species hit is contrary to the species expected (e.g. \"avium\" rather than \"tuberculosis\" - only tested if you provide that expectation)\\\n 15. (Warn) If the top species hit is supported by < 75% coverage\\\n 16. (Warn) If the top species hit has a median coverage depth < 10-fold\\\n 17. (Warn) If we are unable to associate an NCBI taxon ID to any given contaminant species, which means we will not be able to locate its genome, and thereby remove it as a contaminant\\\n 18. (Warn) If we are unable to determine a URL for the latest RefSeq genome associated with a contaminant species' taxon ID\\\n 19. (Warn) If no complete genome could be found for a contaminant species. The workflow will proceed with alignment-based contaminant removal, but you're warned that there's reduced confidence in detecting reads from this species\n \n process preprocessing_downloadContamGenomes\\\n 20. (Fail) If a contaminant is detected but we are unable to download a representative genome, and thereby remove it\n \n process preprocessing_summarise\\\n 21. (Fail) If after having taken an alignment-based approach to decontamination, Kraken still detects a contaminant species\\\n 22. (Fail) If after having taken an alignment-based approach to decontamination, the top species hit is not one of the 10 supported Mycobacteria\\\n 23. (Fail) If, after successfully removing contaminants, the top species hit is contrary to the species expected (e.g. \"avium\" rather than \"tuberculosis\" - only tested if you provide that expectation)\n\n","has_starred","hub_user","immutable_tags_settings",{"_76":11,"_77":78},"enabled","rules",[79],".*","is_automated","permissions",{"_83":22,"_84":11,"_85":11},"read","write","admin","user","storage_size",1003053052,"orgData","recentTags",[92],{"_93":45,"_94":95,"_96":97,"_98":99,"_100":101,"_51":119,"_120":95,"_121":34,"_122":57,"_58":123,"_124":125,"_126":110,"_127":119,"_128":67,"_129":22},"content_type","creator",6447977,"full_size",334792314,"id",142639755,"images",[102],{"_103":104,"_105":106,"_107":108,"_109":110,"_111":112,"_113":114,"_115":108,"_116":-5,"_117":97,"_64":67,"_118":-5},"architecture","amd64","digest","sha256:ad399a520d94db410d7c2ab3d28c96a82d0e8e49a212a06197dbde6ac4a50f41","features","","last_pulled","2026-10-25T20:19:27.479190683Z","last_pushed","2021-05-12T19:39:12Z","os","linux","os_features","os_version","size","variant","2021-05-12T19:39:11.969689Z","last_updater","last_updater_username","media_type","latest","repository",11921362,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxRunInCloud","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_39":144,"_151":152,"_138":161,"_162":11},{"_41":145,"_43":146,"_46":47,"_48":49,"_50":11,"_51":52,"_53":54,"_55":147,"_58":36,"_33":34,"_59":60,"_61":45,"_62":63,"_64":65,"_66":67,"_68":-5,"_69":63,"_70":71,"_72":11,"_73":34,"_74":148,"_80":11,"_81":150,"_86":34,"_87":88},[],[45],[57],{"_76":11,"_77":149},[79],{"_83":22,"_84":11,"_85":11},"tags",{"_153":65,"_154":-5,"_155":-5,"_156":157},"count","next","previous","results",[158],{"_93":45,"_94":95,"_96":97,"_98":99,"_100":159,"_51":119,"_120":95,"_121":34,"_122":57,"_58":123,"_124":125,"_126":110,"_127":119,"_128":67,"_129":22},[160],{"_103":104,"_105":106,"_107":108,"_109":110,"_111":112,"_113":114,"_115":108,"_116":-5,"_117":97,"_64":67,"_118":-5},[],"canDeleteTags","actionData","errors"]

annacprice/ppbedtools

Tags for annacprice/ppbedtools