nf-core/hgtseq
A pipeline to investigate horizontal gene transfer from NGS data
1.0.0). The latest
stable release is
1.1.0
.
Define where the pipeline should find input data and save output data.
Path to comma-separated file containing information about the samples in the experiment.
string^\S+\.csv$The output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.
stringEmail address for completion summary.
string^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$MultiQC report title. Printed as page header, used for filename if not otherwise specified.
stringIndicates if input files are BAMs: if not, FASTQ files are assumed and alignment is run
booleanDefines if pipeline is running a test or using full scale inputs
booleanTaxID of samples used as input
numberChoose if aligner should be bwa-mem or bwa-mem2
stringChoose if multiqc has data to add kraken to report
booleantrueReference genome related files and options required for the workflow.
Name of iGenomes reference.
stringPath to FASTA genome file.
string^\S+\.fn?a(sta)?(\.gz)?$Directory / URL base for iGenomes references.
strings3://ngi-igenomes/igenomesDo not load the iGenomes reference config.
booleanA local path to kraken database folder or compressed database file, or a URL to a compressed database file, in tar.gz format
stringNoneA local path or a URL to a .tab krona taxonomy file; it can also receive a compressed .tab file in tar.gz format
stringNonePath to GFF/GTF annotation file.
stringPath bwa-mem indexes
stringNonePath bwa-mem2 indexes
stringNoneParameters used to describe centralised config profiles. These should not be edited.
Git commit id for Institutional configs.
stringmasterBase directory for Institutional configs.
stringhttps://raw.githubusercontent.com/nf-core/configs/masterInstitutional config name.
stringInstitutional config description.
stringInstitutional config contact information.
stringInstitutional config URL link.
stringSet the top limit for requested resources for any single job.
Maximum number of CPUs that can be requested for any single job.
integer16Maximum amount of memory that can be requested for any single job.
string128.GB^\d+(\.\d+)?\.?\s*(K|M|G|T)?B$Maximum amount of time that can be requested for any single job.
string240.h^(\d+\.?\s*(s|m|h|day)\s*)+$Less common options for the pipeline, typically set in a config file.
Display help text.
booleanMethod used to save pipeline results to output directory.
stringEmail address for completion summary, only when pipeline fails.
string^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$Send plain-text email instead of HTML.
booleanFile size limit when attaching MultiQC reports to summary emails.
string25.MB^\d+(\.\d+)?\.?\s*(K|M|G|T)?B$Do not use coloured log outputs.
booleanCustom config file to supply to MultiQC.
stringDirectory to keep pipeline Nextflow logs and reports.
string${params.outdir}/pipeline_infoBoolean whether to validate parameters against the schema at runtime
booleantrueShow all params when using --help
booleanRun this workflow with Conda. You can also use ‘-profile conda’ instead of providing this parameter.
booleanTrimgalore trimmings options
Instructs Trim Galore to remove bp from the 5’ end of read 1.
stringNoneInstructs Trim Galore to remove bp from the 5’ end of read 2.
stringNoneInstructs Trim Galore to remove bp from the 3’ end of read 1 after adapter/quality trimming has been performed.
stringNoneInstructs Trim Galore to remove bp from the 3’ end of read 2 after adapter/quality trimming has been performed.
stringNone