Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add description for the parameters exposed to the workflow #27

Open
anwarMZ opened this issue Oct 31, 2023 · 0 comments
Open

Add description for the parameters exposed to the workflow #27

anwarMZ opened this issue Oct 31, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@anwarMZ
Copy link
Member

anwarMZ commented Oct 31, 2023

Description of the bug

Add the description of each parameter to the workflow template

Command used and terminal output

nextflow run main.nf --help

Typical pipeline command:

  nextflow run nf-core/seqqc --input samplesheet.csv --fasta reference.fa -profile docker

Sequencing parameters
  --mode                        [string]  null [default: illumina]
  --nanopore_summary_file       [string]  null
  --nanopore_summary_file_id    [string]  null

Assembly QC
  --checkm_db                   [string]  null [default: "null"]
  --combine_quast               [boolean] null
  --busco_lineage               [string]  null [default: auto]
  --busco_lineages_path         [string]  null
  --busco_config                [boolean] null
  --skip_checkm                 [boolean] null
  --skip_quast                  [boolean] null
  --skip_busco                  [boolean] null
  --reference_genome_fasta      [string]  null
  --reference_genome_gff        [string]  null
  --skip_assembly_qc            [boolean] null
  --skip_rmlst                  [boolean] null

Relevant files

nextflow_schema.json needs to be updated

System information

No response

@anwarMZ anwarMZ added the documentation Improvements or additions to documentation label Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants