nf-core/hlatyping
Precision HLA typing from next-generation sequencing data
1.2.0). The latest
stable release is
2.0.0
.
Define where the pipeline should find input data and save output data.
Input FastQ or BAM files.
stringUse this to specify the location of your input FastQ files. For example:
--input 'path/to/data/sample_*_{1,2}.fastq'
Please note the following requirements:
- The path must be enclosed in quotes
- The path must have at least one
*wildcard character - When using the pipeline with paired end data, the path must use
{1,2}notation to specify read pairs.
If left unspecified, a default pattern is used: data/*{1,2}.fastq.gz
Input multiple FastQ or BAM files.
stringundefinedSpecifies that the input is single-end reads.
booleanBy default, the pipeline expects paired-end data. If you have single-end data, you need to specify --single_end on the command line when you launch the pipeline. A normal glob pattern, enclosed in quotation marks, can then be used for --input. For example:
--single_end --input '*.fastq'
It is not possible to run a mixture of single-end and paired-end files in one run.
Specifies that the input is in BAM format.
booleanBy default, the pipeline expects input data as .fastq{.gz}. You can also provide .bam files as input and combine it with the --single_end option, if necessary.
This will trigger the pipeline to extract the reads from the .bam file and remap them against the HLA reference sequence, using the yara mapper. Indices and references are shipped with this pipeline.
Specifies whether the input is DNA or RNA.
stringdnaBy default, the pipeline assumes DNA as input sequence type. In case you want to use RNA data as input, just provide the option with --seqtype 'rna'.
The output directory where the results will be saved.
string./resultsEmail address for completion summary.
string^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$Set this parameter to your e-mail address to get a summary e-mail with details of the run sent to you when the workflow exits. If set in your user config file (~/.nextflow/config) then you don't need to specify this on the command line for every run.
Options for the optimisation step of the HLA typing pipeline.
Specifies the integer programming solver.
stringglpkBy default, the pipeline uses the glpk integer programming (IP) solver. With this pipeline, there is also native support for the cbc solver, just pass it as argument with --solver 'cbc', and the pipeline will run OptiType using this IP solver.
Specifies the number of output solutions.
integer1By default, the pipeline will do one enumeration (--enumerations 1). If you want OptiType to output the optimal solution and the top N-1 suboptimal solutions in the result file, please specify the number of enumerations accordingly.
Specifies the weight of the regularisation term.
number0.009By default, the pipeline uses a beta value of 0.009. The constant beta weights the regularisation term of the underlying integer linear program to account for homozygosity since the formulation favors heterozygous allele combinations. Beta represents the proportion of reads that need to be additionally explained by a chosen allele combination in order to choose heterzygous solutions over homzygous solutions. Evaluation of different values for beta showed the best performance with 0.009. Please refer to the original publication of OptiType (doi: 10.1093/bioinformatics/btu548) for details.
Options for the reference genome indices used to align reads.
Directory / URL base for iGenomes references.
strings3://ngi-igenomes/igenomes/Do not load the iGenomes reference config.
booleanDo not load igenomes.config when running the pipeline. You may choose this option if you observe clashes between custom parameters and those supplied in igenomes.config.
Path for the mapping reference index location.
string$baseDir/data/indices/yaraName of the mapping reference index.
stringLess common options for the pipeline, typically set in a config file.
Display help text.
booleanMethod used to save pipeline results to output directory.
stringThe Nextflow publishDir option specifies which intermediate files should be saved to the output directory. This option tells the pipeline what method should be used to move these files. See Nextflow docs for details.
Workflow name.
stringA custom name for the pipeline run. Unlike the core nextflow -name option with one hyphen this parameter can be reused multiple times, for example if using -resume. Passed through to steps such as MultiQC and used for things like report filenames and titles.
Email address for completion summary, only when pipeline fails.
string^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$This works exactly as with --email, except emails are only sent if the workflow is not successful.
Send plain-text email instead of HTML.
booleanSet to receive plain-text e-mails instead of HTML formatted.
File size limit when attaching MultiQC reports to summary emails.
string25.MBIf file generated by pipeline exceeds the threshold, it will not be attached.
Do not use coloured log outputs.
booleanSet to disable colourful command line output and live life in monochrome.
Custom config file to supply to MultiQC.
stringDirectory to keep pipeline Nextflow logs and reports.
string${params.outdir}/pipeline_infoSet the top limit for requested resources for any single job.
Maximum number of CPUs that can be requested for any single job.
integer16Use to set an upper-limit for the CPU requirement for each process. Should be an integer e.g. --max_cpus 1
Maximum amount of memory that can be requested for any single job.
string128.GBUse to set an upper-limit for the memory requirement for each process. Should be a string in the format integer-unit e.g. --max_memory '8.GB'
Maximum amount of time that can be requested for any single job.
string240.hUse to set an upper-limit for the time requirement for each process. Should be a string in the format integer-unit e.g. --max_time '2.h'
Parameters used to describe centralised config profiles. These should not be edited.
Git commit id for Institutional configs.
stringmasterProvide git commit id for custom Institutional configs hosted at nf-core/configs. This was implemented for reproducibility purposes. Default: master.
## Download and use config file with following git commit id
--custom_config_version d52db660777c4bf36546ddb188ec530c3ada1b96
Base directory for Institutional configs.
stringhttps://raw.githubusercontent.com/nf-core/configs/masterIf you're running offline, nextflow will not be able to fetch the institutional config files from the internet. If you don't need them, then this is not a problem. If you do need them, you should download the files from the repo and tell nextflow where to find them with the custom_config_base option. For example:
## Download and unzip the config files
cd /path/to/my/configs
wget https://github.com/nf-core/configs/archive/master.zip
unzip master.zip
## Run the pipeline
cd /path/to/my/data
nextflow run /path/to/pipeline/ --custom_config_base /path/to/my/configs/configs-master/
Note that the nf-core/tools helper package has a
downloadcommand to download all required pipeline files + singularity containers + institutional configs in one go for you, to make this process easier.
Institutional configs hostname.
stringInstitutional config description.
stringInstitutional config contact information.
stringInstitutional config URL link.
string