diff --git a/docs/images/mess-citation.svg b/docs/images/mess-citation.svg new file mode 100644 index 0000000..dc0102d --- /dev/null +++ b/docs/images/mess-citation.svg @@ -0,0 +1,166 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + $ mess citation +Please cite MeSS and assembly_finder in your paper using this article: + + +Please consider also citing these dependencies: +ART: +https://doi.org/10.1093/bioinformatics/btr708 + +Bioconvert: +https://doi.org/10.1093/nargab/lqad074 + +PBSIM3: +https://doi.org/10.1093/nargab/lqac092 + +Snakemake: +https://doi.org/10.12688/f1000research.29032.1 + +Snaketool: +https://doi.org/10.1371/journal.pcbi.1010705 + +Seqkit2: +https://doi.org/10.1002/imt2.191 + +Samtools: +https://doi.org/10.1093/gigascience/giab008 + +Taxonkit: +https://doi.org/10.1016/j.jgg.2021.03.006 + + + + diff --git a/docs/images/mess-download-help.svg b/docs/images/mess-download-help.svg new file mode 100644 index 0000000..3bfdf44 --- /dev/null +++ b/docs/images/mess-download-help.svg @@ -0,0 +1,298 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + $ mess download -h + +Usage:mess download [OPTIONS] [SNAKE_ARGS]...                                       + + Download genomes with assembly_finder                                                + +╭─ Common options ──────────────────────────────────────────────────────────────────╮ +│*--input-i  Path to input table(s) (PATH)[required]│ +│--output-o  Output directory (PATH)[default: mess_out]│ +│--threads       Number of threads to use (INTEGER)[default: 1]│ +│--taxonkit      Define path to taxonkit data-dir                               │ +│(PATH)                                                        │ +│[default:                                                     │ +│/opt/hostedtoolcache/Python/3.12.3/x64/lib/python3.12/site-pa…│ +│--help-h  Show this message and exit.                                    │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Download options ────────────────────────────────────────────────────────────────╮ +│--api-key              NCBI api-key (TEXT)│ +│--limit                Limit number of genomes per query (TEXT)│ +│--compressed           Download compressed files [default: True]│ +│--include              Comma seperated files to download :                        │ +│                        genome,rna,protein,cds,gff3,gtf,gbff,seq-report,none       │ +│(TEXT)                                                    │ +│[default: genome,seq-report]                              │ +│--source               Download from refseq or genbank or both                    │ +│(refseq|genbank|all)                   │ +│[default: all]                         │ +│--taxon/--accession    Are queries taxa names or accession [default: taxon]│ +│--reference            Limit to reference and representative genomes              │ +│[default: True]                              │ +│--assembly-level       Comma seperated list of assembly level:                    │ +│                        complete,chromosome,scaffold,contig                        │ +│(TEXT)                                                    │ +│--annotated            Select annotated genomes only [default: False]│ +│--atypical             Exclude atypical genomes [default: True]│ +│--mag                  Exclude, include or limit to metagenome assembled genomes  │ +│(exclude|all|only)                                       │ +│[default: all]                                           │ +│--rank                 taxonomic rank to filter by assemblies                     │ +│(superkingdom|phylum|class|order|family|genus|species)│ +│--nrank                Number of genomes per taxonomic rank (INTEGER)│ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Snakemake options ───────────────────────────────────────────────────────────────╮ +│--configfile                  Custom config file [default:                        │ +│                               (outputDir)/config.yaml]                            │ +│(TEXT)                                             │ +│--profile                     Snakemake profile to use (TEXT)│ +│--use-conda/--no-use-conda    Use conda for Snakemake rules [default: use-conda]│ +│--conda-prefix                Define conda env directory (PATH)│ +│--snake-default               Customise Snakemake runtime args                    │ +│(TEXT)                                             │ +│[default: --printshellcmds, --nolock,              │ +│--show-failed-logs]                                │ +╰───────────────────────────────────────────────────────────────────────────────────╯ + + Downloads genomes from taxons/accessions in input table(s)                           + EXAMPLES: mess download -i [input] -o [output]                                       + + + + + + diff --git a/docs/images/mess-help.svg b/docs/images/mess-help.svg index 454ea1e..40a9242 100644 --- a/docs/images/mess-help.svg +++ b/docs/images/mess-help.svg @@ -19,129 +19,129 @@ font-weight: 700; } - .terminal-1574014372-matrix { + .terminal-2388867207-matrix { font-family: Fira Code, monospace; font-size: 20px; line-height: 24.4px; font-variant-east-asian: full-width; } - .terminal-1574014372-title { + .terminal-2388867207-title { font-size: 18px; font-weight: bold; font-family: arial; } - .terminal-1574014372-r1 { fill: #c5c8c6 } -.terminal-1574014372-r2 { fill: #d0b344 } -.terminal-1574014372-r3 { fill: #c5c8c6;font-weight: bold } -.terminal-1574014372-r4 { fill: #68a0b3;font-weight: bold } -.terminal-1574014372-r5 { fill: #868887 } -.terminal-1574014372-r6 { fill: #4e707b;font-weight: bold } -.terminal-1574014372-r7 { fill: #98a84b;font-weight: bold } + .terminal-2388867207-r1 { fill: #c5c8c6 } +.terminal-2388867207-r2 { fill: #d0b344 } +.terminal-2388867207-r3 { fill: #c5c8c6;font-weight: bold } +.terminal-2388867207-r4 { fill: #68a0b3;font-weight: bold } +.terminal-2388867207-r5 { fill: #868887 } +.terminal-2388867207-r6 { fill: #4e707b;font-weight: bold } +.terminal-2388867207-r7 { fill: #98a84b;font-weight: bold } - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -153,43 +153,43 @@ - + - - $ mess -h - -Usage:mess [OPTIONS] COMMAND [ARGS]...                                              - - - ___  ___     _____ _____                                                             - |  \/  |    /  ___/  ___|                                                            - | .  . | ___\ `--.\ `--.                                                             - | |\/| |/ _ \`--. \`--. \                                                            - | |  | |  __/\__/ /\__/ /                                                            - \_|  |_/\___\____/\____/                                                             - - For more options:                                                                    -mess [command] --help - -╭─ Help ────────────────────────────────────────────────────────────────────────────╮ -│--help-h  Show this message and exit.                                        │ -│--version-v  Show the version and exit.                                         │ -╰───────────────────────────────────────────────────────────────────────────────────╯ -╭─ Main usage ──────────────────────────────────────────────────────────────────────╮ -│run                        Run MeSS workflow: download and simulate commands     │ -│download                   Download genomes with assembly_finder                 │ -│simulate                   Simulate reads from local fastas                      │ -│hmp-template               Download and simulate healthy human microbiome        │ -│ templates                                             │ -╰───────────────────────────────────────────────────────────────────────────────────╯ -╭─ Config/Test ─────────────────────────────────────────────────────────────────────╮ -│config                     Copy the system default config file                   │ -│test                       Run mess on test data                                 │ -╰───────────────────────────────────────────────────────────────────────────────────╯ -╭─ Cite ────────────────────────────────────────────────────────────────────────────╮ -│citation                   Print the citation(s) for this tool                   │ -╰───────────────────────────────────────────────────────────────────────────────────╯ - + + $ mess -h + +Usage:mess [OPTIONS] COMMAND [ARGS]...                                              + + + ___  ___     _____ _____                                                             + |  \/  |    /  ___/  ___|                                                            + | .  . | ___\ `--.\ `--.                                                             + | |\/| |/ _ \`--. \`--. \                                                            + | |  | |  __/\__/ /\__/ /                                                            + \_|  |_/\___\____/\____/                                                             + + For more options:                                                                    +mess [command] --help + +╭─ Help ────────────────────────────────────────────────────────────────────────────╮ +│--help-h  Show this message and exit.                                        │ +│--version-v  Show the version and exit.                                         │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Main usage ──────────────────────────────────────────────────────────────────────╮ +│run                        Run MeSS workflow: download and simulate commands     │ +│download                   Download genomes with assembly_finder                 │ +│simulate                   Simulate reads from local fastas                      │ +│hmp-template               Download and simulate healthy human microbiome        │ +│ templates                                             │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Config/Test ─────────────────────────────────────────────────────────────────────╮ +│config                     Copy the system default config file                   │ +│test                       Run mess on test data                                 │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Cite ────────────────────────────────────────────────────────────────────────────╮ +│citation                   Print the citation(s) for this tool                   │ +╰───────────────────────────────────────────────────────────────────────────────────╯ + diff --git a/docs/images/mess-hmp-help.svg b/docs/images/mess-hmp-help.svg new file mode 100644 index 0000000..a5a0ac3 --- /dev/null +++ b/docs/images/mess-hmp-help.svg @@ -0,0 +1,594 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + $ mess hmp-template -h + +Usage:mess hmp-template [OPTIONS] [SNAKE_ARGS]...                                   + + Download and simulate healthy human microbiome templates                             + +╭─ Hmp-template options ────────────────────────────────────────────────────────────╮ +│*--site      Choose microbiome site (gut|buccal_mucosa|vagina|throat)│ +│[required]            │ +│--sample    choose sample template (TEXT)│ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Common options ──────────────────────────────────────────────────────────────────╮ +│--output-o  Output directory (PATH)[default: mess_out]│ +│--threads       Number of threads to use (INTEGER)[default: 1]│ +│--taxonkit      Define path to taxonkit data-dir                                  │ +│(PATH)                                                           │ +│[default:                                                        │ +│/opt/hostedtoolcache/Python/3.12.3/x64/lib/python3.12/site-packa…│ +│--help-h  Show this message and exit.                                       │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Download options ────────────────────────────────────────────────────────────────╮ +│--api-key              NCBI api-key (TEXT)│ +│--limit                Limit number of genomes per query (TEXT)│ +│--compressed           Download compressed files [default: True]│ +│--include              Comma seperated files to download :                        │ +│                        genome,rna,protein,cds,gff3,gtf,gbff,seq-report,none       │ +│(TEXT)                                                    │ +│[default: genome,seq-report]                              │ +│--source               Download from refseq or genbank or both                    │ +│(refseq|genbank|all)                   │ +│[default: all]                         │ +│--taxon/--accession    Are queries taxa names or accession [default: taxon]│ +│--reference            Limit to reference and representative genomes              │ +│[default: True]                              │ +│--assembly-level       Comma seperated list of assembly level:                    │ +│                        complete,chromosome,scaffold,contig                        │ +│(TEXT)                                                    │ +│--annotated            Select annotated genomes only [default: False]│ +│--atypical             Exclude atypical genomes [default: True]│ +│--mag                  Exclude, include or limit to metagenome assembled genomes  │ +│(exclude|all|only)                                       │ +│[default: all]                                           │ +│--rank                 taxonomic rank to filter by assemblies                     │ +│(superkingdom|phylum|class|order|family|genus|species)│ +│--nrank                Number of genomes per taxonomic rank (INTEGER)│ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Common simulators options ───────────────────────────────────────────────────────╮ +│--tech            Sequencing technology (illumina|pacbio|nanopore)│ +│[default: illumina]  │ +│--bases           Per sample base counts (ignored when coverage is set) (TEXT)│ +│[default: 1G]                                        │ +│--tool            Which simulator to use (art|pbsim3)[default: art]│ +│--error           Simulator error profile (TEXT)[default: HS25]│ +│--mean-len        Mean read length for long and short read sequencing (INTEGER)│ +│--bam/--no-bam    Generate gold standard bam files [default: no-bam]│ +│--seed            Seed for pseudo random number generator (INTEGER)[default: 42]│ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ art_illumina options ────────────────────────────────────────────────────────────╮ +│--custom-err    Path to art custom error profile basename (TEXT)│ +│--paired        Illumina reads pairing [default: True]│ +│--frag-len      Fragment length for paired short read sequencing (INTEGER)│ +│[default: 200]                                  │ +│--frag-sd       Fragment length standard deviation for paired short read          │ +│                 sequencing                                                        │ +│(INTEGER)                                                        │ +│[default: 10]                                                    │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ pbsim3 options ──────────────────────────────────────────────────────────────────╮ +│--model         Path to pbsim3 sequencing error models                            │ +│(QSHMM-ONT-HQ|QSHMM-ONT|QSHMM-RSII)   │ +│--model-path    Path to pbsim3 sequencing error models                            │ +│(PATH)                                                           │ +│[default:                                                        │ +│/opt/hostedtoolcache/Python/3.12.3/x64/lib/python3.12/site-packa…│ +│--ratio         PBSIM3 substitution, insertion and deletion ratio (TEXT)│ +│[default: 6:55:39]                               │ +│--accuracy      Mean accuracy for long read sequencing (FLOAT)[default: 0.99]│ +│--passes        Nmber of passes for pacbio multipass sequencing (2 or more for    │ +│                 hifi)                                                             │ +│(INTEGER)                                                        │ +│[default: 1]                                                     │ +│--min-len       Minimum read length for long read sequencing (INTEGER)│ +│[default: 100]                              │ +│--max-len       Maximum read length for long read sequencing (INTEGER)│ +│[default: 1000000]                          │ +│--sd-len        Standard read length deviation for long read sequencing (INTEGER)│ +│[default: 7000]                                        │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Replicates options ──────────────────────────────────────────────────────────────╮ +│--replicates    Number of replicates per sample (INTEGER)[default: 1]│ +│--rep-sd        Standard deviation between replicate coverages (0: no deviation)  │ +│(INTEGER)                                                       │ +│[default: 0]                                                    │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Abundance distribution options ──────────────────────────────────────────────────╮ +│--dist     Sample taxonomic abundances from a distribution (none|lognormal|even)│ +│[default: none]                                │ +│--mu       Mu of lognormal dist (INTEGER)│ +│--sigma    Sigma of lognormal dist (INTEGER)│ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Taxonomic profile options ───────────────────────────────────────────────────────╮ +│--abundance    Choose sequence or taxonomic abundance to include in the taxonomic │ +│                profile                                                            │ +│(seq|tax)                                                         │ +│[default: seq]                                                    │ +│--ranks        Ranks to show in the taxonomic profile                             │ +│(TEXT)                                                            │ +│[default:                                                         │ +│superkingdom,phylum,class,order,family,genus,species,strain]      │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Skip options ────────────────────────────────────────────────────────────────────╮ +│--skip-shuffle    Skip fastq shuffling                                            │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Snakemake options ───────────────────────────────────────────────────────────────╮ +│--configfile                  Custom config file [default:                        │ +│                               (outputDir)/config.yaml]                            │ +│(TEXT)                                             │ +│--profile                     Snakemake profile to use (TEXT)│ +│--use-conda/--no-use-conda    Use conda for Snakemake rules [default: use-conda]│ +│--conda-prefix                Define conda env directory (PATH)│ +│--snake-default               Customise Snakemake runtime args                    │ +│(TEXT)                                             │ +│[default: --printshellcmds, --nolock,              │ +│--show-failed-logs]                                │ +╰───────────────────────────────────────────────────────────────────────────────────╯ + + Command to download and simulate healthy human microbiome templates                  + EXAMPLES:                                                                            + mess hmp-template --site gut -o gut                                                  + or                                                                                   + mess hmp-template --site buccal_mucosa --sample SRS013506 -o SRS013506               + + + + + + diff --git a/docs/images/mess-run-help.svg b/docs/images/mess-run-help.svg new file mode 100644 index 0000000..04036c4 --- /dev/null +++ b/docs/images/mess-run-help.svg @@ -0,0 +1,594 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + $ mess run -h + +Usage:mess run [OPTIONS] [SNAKE_ARGS]...                                            + + Run MeSS workflow: download and simulate commands                                    + +╭─ Common options ──────────────────────────────────────────────────────────────────╮ +│*--input-i  Path to input table(s) (PATH)[required]│ +│--output-o  Output directory (PATH)[default: mess_out]│ +│--threads       Number of threads to use (INTEGER)[default: 1]│ +│--taxonkit      Define path to taxonkit data-dir                               │ +│(PATH)                                                        │ +│[default:                                                     │ +│/opt/hostedtoolcache/Python/3.12.3/x64/lib/python3.12/site-pa…│ +│--help-h  Show this message and exit.                                    │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Download options ────────────────────────────────────────────────────────────────╮ +│--api-key              NCBI api-key (TEXT)│ +│--limit                Limit number of genomes per query (TEXT)│ +│--compressed           Download compressed files [default: True]│ +│--include              Comma seperated files to download :                        │ +│                        genome,rna,protein,cds,gff3,gtf,gbff,seq-report,none       │ +│(TEXT)                                                    │ +│[default: genome,seq-report]                              │ +│--source               Download from refseq or genbank or both                    │ +│(refseq|genbank|all)                   │ +│[default: all]                         │ +│--taxon/--accession    Are queries taxa names or accession [default: taxon]│ +│--reference            Limit to reference and representative genomes              │ +│[default: True]                              │ +│--assembly-level       Comma seperated list of assembly level:                    │ +│                        complete,chromosome,scaffold,contig                        │ +│(TEXT)                                                    │ +│--annotated            Select annotated genomes only [default: False]│ +│--atypical             Exclude atypical genomes [default: True]│ +│--mag                  Exclude, include or limit to metagenome assembled genomes  │ +│(exclude|all|only)                                       │ +│[default: all]                                           │ +│--rank                 taxonomic rank to filter by assemblies                     │ +│(superkingdom|phylum|class|order|family|genus|species)│ +│--nrank                Number of genomes per taxonomic rank (INTEGER)│ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Common simulators options ───────────────────────────────────────────────────────╮ +│--tech            Sequencing technology (illumina|pacbio|nanopore)│ +│[default: illumina]  │ +│--bases           Per sample base counts (ignored when coverage is set) (TEXT)│ +│[default: 1G]                                        │ +│--tool            Which simulator to use (art|pbsim3)[default: art]│ +│--error           Simulator error profile (TEXT)[default: HS25]│ +│--mean-len        Mean read length for long and short read sequencing (INTEGER)│ +│--bam/--no-bam    Generate gold standard bam files [default: no-bam]│ +│--seed            Seed for pseudo random number generator (INTEGER)[default: 42]│ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ art_illumina options ────────────────────────────────────────────────────────────╮ +│--custom-err    Path to art custom error profile basename (TEXT)│ +│--paired        Illumina reads pairing [default: True]│ +│--frag-len      Fragment length for paired short read sequencing (INTEGER)│ +│[default: 200]                                  │ +│--frag-sd       Fragment length standard deviation for paired short read          │ +│                 sequencing                                                        │ +│(INTEGER)                                                        │ +│[default: 10]                                                    │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ pbsim3 options ──────────────────────────────────────────────────────────────────╮ +│--model         Path to pbsim3 sequencing error models                            │ +│(QSHMM-ONT-HQ|QSHMM-ONT|QSHMM-RSII)   │ +│--model-path    Path to pbsim3 sequencing error models                            │ +│(PATH)                                                           │ +│[default:                                                        │ +│/opt/hostedtoolcache/Python/3.12.3/x64/lib/python3.12/site-packa…│ +│--ratio         PBSIM3 substitution, insertion and deletion ratio (TEXT)│ +│[default: 6:55:39]                               │ +│--accuracy      Mean accuracy for long read sequencing (FLOAT)[default: 0.99]│ +│--passes        Nmber of passes for pacbio multipass sequencing (2 or more for    │ +│                 hifi)                                                             │ +│(INTEGER)                                                        │ +│[default: 1]                                                     │ +│--min-len       Minimum read length for long read sequencing (INTEGER)│ +│[default: 100]                              │ +│--max-len       Maximum read length for long read sequencing (INTEGER)│ +│[default: 1000000]                          │ +│--sd-len        Standard read length deviation for long read sequencing (INTEGER)│ +│[default: 7000]                                        │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Replicates options ──────────────────────────────────────────────────────────────╮ +│--replicates    Number of replicates per sample (INTEGER)[default: 1]│ +│--rep-sd        Standard deviation between replicate coverages (0: no deviation)  │ +│(INTEGER)                                                       │ +│[default: 0]                                                    │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Abundance distribution options ──────────────────────────────────────────────────╮ +│--dist     Sample taxonomic abundances from a distribution (none|lognormal|even)│ +│[default: none]                                │ +│--mu       Mu of lognormal dist (INTEGER)│ +│--sigma    Sigma of lognormal dist (INTEGER)│ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Taxonomic profile options ───────────────────────────────────────────────────────╮ +│--abundance    Choose sequence or taxonomic abundance to include in the taxonomic │ +│                profile                                                            │ +│(seq|tax)                                                         │ +│[default: seq]                                                    │ +│--ranks        Ranks to show in the taxonomic profile                             │ +│(TEXT)                                                            │ +│[default:                                                         │ +│superkingdom,phylum,class,order,family,genus,species,strain]      │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Skip options ────────────────────────────────────────────────────────────────────╮ +│--skip-shuffle    Skip fastq shuffling                                            │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Snakemake options ───────────────────────────────────────────────────────────────╮ +│--configfile                  Custom config file [default:                        │ +│                               (outputDir)/config.yaml]                            │ +│(TEXT)                                             │ +│--profile                     Snakemake profile to use (TEXT)│ +│--use-conda/--no-use-conda    Use conda for Snakemake rules [default: use-conda]│ +│--conda-prefix                Define conda env directory (PATH)│ +│--snake-default               Customise Snakemake runtime args                    │ +│(TEXT)                                             │ +│[default: --printshellcmds, --nolock,              │ +│--show-failed-logs]                                │ +╰───────────────────────────────────────────────────────────────────────────────────╯ + +  CLUSTER EXECUTION: mess run ... --profile [profile] For information on Snakemake    + profiles see:                                                                        + https://snakemake.readthedocs.io/en/stable/executing/cli.html#profiles  RUN          + EXAMPLES: Required:           mess run --input [file] Specify threads:    mess run   + ... --threads [threads] Disable conda:      mess run ... --no-use-conda  Change      + defaults:    mess run ... --snake-default="-k--nolock" Add Snakemake args: mess     + run ... --dry-run--keep-going--touch Specify targets:    mess run ... all          + print_targets Available targets:     all             Run everything (default)        + print_targets   List available targets                                               + + + + + + diff --git a/docs/images/mess-simulate-help.svg b/docs/images/mess-simulate-help.svg new file mode 100644 index 0000000..0fab321 --- /dev/null +++ b/docs/images/mess-simulate-help.svg @@ -0,0 +1,498 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + $ mess simulate -h + +Usage:mess simulate [OPTIONS] [SNAKE_ARGS]...                                       + + Simulate reads from local fastas                                                     + +╭─ Common options ──────────────────────────────────────────────────────────────────╮ +│*--input-i  Path to input table(s) (PATH)[required]│ +│--output-o  Output directory (PATH)[default: mess_out]│ +│--threads       Number of threads to use (INTEGER)[default: 1]│ +│--taxonkit      Define path to taxonkit data-dir                               │ +│(PATH)                                                        │ +│[default:                                                     │ +│/opt/hostedtoolcache/Python/3.12.3/x64/lib/python3.12/site-pa…│ +│--help-h  Show this message and exit.                                    │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Local genomes options ───────────────────────────────────────────────────────────╮ +│--asm-summary    Summary table with genome sizes, fasta paths, contig counts...   │ +│(TEXT)                                                        │ +│--fasta          Path to local fasta directory if no path is set in summary or    │ +│                  input table                                                      │ +│(TEXT)                                                          │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Common simulators options ───────────────────────────────────────────────────────╮ +│--tech            Sequencing technology (illumina|pacbio|nanopore)│ +│[default: illumina]  │ +│--bases           Per sample base counts (ignored when coverage is set) (TEXT)│ +│[default: 1G]                                        │ +│--tool            Which simulator to use (art|pbsim3)[default: art]│ +│--error           Simulator error profile (TEXT)[default: HS25]│ +│--mean-len        Mean read length for long and short read sequencing (INTEGER)│ +│--bam/--no-bam    Generate gold standard bam files [default: no-bam]│ +│--seed            Seed for pseudo random number generator (INTEGER)[default: 42]│ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ art_illumina options ────────────────────────────────────────────────────────────╮ +│--custom-err    Path to art custom error profile basename (TEXT)│ +│--paired        Illumina reads pairing [default: True]│ +│--frag-len      Fragment length for paired short read sequencing (INTEGER)│ +│[default: 200]                                  │ +│--frag-sd       Fragment length standard deviation for paired short read          │ +│                 sequencing                                                        │ +│(INTEGER)                                                        │ +│[default: 10]                                                    │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ pbsim3 options ──────────────────────────────────────────────────────────────────╮ +│--model         Path to pbsim3 sequencing error models                            │ +│(QSHMM-ONT-HQ|QSHMM-ONT|QSHMM-RSII)   │ +│--model-path    Path to pbsim3 sequencing error models                            │ +│(PATH)                                                           │ +│[default:                                                        │ +│/opt/hostedtoolcache/Python/3.12.3/x64/lib/python3.12/site-packa…│ +│--ratio         PBSIM3 substitution, insertion and deletion ratio (TEXT)│ +│[default: 6:55:39]                               │ +│--accuracy      Mean accuracy for long read sequencing (FLOAT)[default: 0.99]│ +│--passes        Nmber of passes for pacbio multipass sequencing (2 or more for    │ +│                 hifi)                                                             │ +│(INTEGER)                                                        │ +│[default: 1]                                                     │ +│--min-len       Minimum read length for long read sequencing (INTEGER)│ +│[default: 100]                              │ +│--max-len       Maximum read length for long read sequencing (INTEGER)│ +│[default: 1000000]                          │ +│--sd-len        Standard read length deviation for long read sequencing (INTEGER)│ +│[default: 7000]                                        │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Replicates options ──────────────────────────────────────────────────────────────╮ +│--replicates    Number of replicates per sample (INTEGER)[default: 1]│ +│--rep-sd        Standard deviation between replicate coverages (0: no deviation)  │ +│(INTEGER)                                                       │ +│[default: 0]                                                    │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Abundance distribution options ──────────────────────────────────────────────────╮ +│--dist     Sample taxonomic abundances from a distribution (none|lognormal|even)│ +│[default: none]                                │ +│--mu       Mu of lognormal dist (INTEGER)│ +│--sigma    Sigma of lognormal dist (INTEGER)│ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Taxonomic profile options ───────────────────────────────────────────────────────╮ +│--abundance    Choose sequence or taxonomic abundance to include in the taxonomic │ +│                profile                                                            │ +│(seq|tax)                                                         │ +│[default: seq]                                                    │ +│--ranks        Ranks to show in the taxonomic profile                             │ +│(TEXT)                                                            │ +│[default:                                                         │ +│superkingdom,phylum,class,order,family,genus,species,strain]      │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Skip options ────────────────────────────────────────────────────────────────────╮ +│--skip-shuffle    Skip fastq shuffling                                            │ +╰───────────────────────────────────────────────────────────────────────────────────╯ +╭─ Snakemake options ───────────────────────────────────────────────────────────────╮ +│--configfile                  Custom config file [default:                        │ +│                               (outputDir)/config.yaml]                            │ +│(TEXT)                                             │ +│--profile                     Snakemake profile to use (TEXT)│ +│--use-conda/--no-use-conda    Use conda for Snakemake rules [default: use-conda]│ +│--conda-prefix                Define conda env directory (PATH)│ +│--snake-default               Customise Snakemake runtime args                    │ +│(TEXT)                                             │ +│[default: --printshellcmds, --nolock,              │ +│--show-failed-logs]                                │ +╰───────────────────────────────────────────────────────────────────────────────────╯ + + Simulate reads from local fasta                                                      + EXAMPLES: mess simulate -i [input] --tech [tech] --fasta [fasta-dir] -o [output]     + or                                                                                   + mess simulate -i [input] --tech [tech] --asm-summary [asm-summary] -o [output]       + + + + + +