Parameters
Input fasta file
You need the input FASTA file that was used in the previous alignment
pattern: ^\S+\.fn?a(sta)?(\.gz)?$
pretext agp file
You need the agp file generated from pretextview
pattern: ^\S+(\.agp)?$
bin/bam file
You need the hicmap file, can be bin file or bam file
pattern: ^\S+?$
fasta index file
You need the fasta index file from the last mapping
pattern: ^\S+(\.fai)?$
The output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.
Email address for completion summary.
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.
pattern: ^([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.
Parameters used to describe centralised config profiles. These should not be edited.
The centralised nf-core configuration profiles use a handful of pipeline parameters to describe themselves. This information is then printed to the Nextflow log when you run a pipeline. You should not need to change these values when you run a pipeline.
Git commit id for Institutional configs.
default: 'master'
Base directory for Institutional configs.
default: 'https://raw.githubusercontent.com/nf-core/configs/master'
If 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 this parameter.
Less common options for the pipeline, typically set in a config file.
These options are common to all nf-core pipelines and allow you to customise some of the core preferences for how the pipeline runs.
Typically these options would be set in a Nextflow config file loaded for all pipeline runs, such as ~/.nextflow/config
.
Method used to save pipeline results to output directory.
The 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.
Email address for completion summary, only when pipeline fails.
An email address to send a summary email to when the pipeline is completed - ONLY sent if the pipeline does not exit successfully.
pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$
File size limit when attaching MultiQC reports to summary emails.
default: '25.MB'
Incoming hook URL for messaging service
Incoming hook URL for messaging service. Currently, MS Teams and Slack are supported.
Custom logo file to supply to MultiQC. File name must also be set in the MultiQC config file
Custom MultiQC yaml file containing HTML including a methods description.
Boolean whether to validate parameters against the schema at runtime
default: 1
Base URL or local path to location of pipeline test dataset files
default: 'https://raw.githubusercontent.com/nf-core/test-datasets/'