nf-core_modules/software/bedtools/intersect/meta.yml
2021-02-07 21:32:01 +00:00

63 lines
2.1 KiB
YAML

name: bedtools_intersect
description: allows one to screen for overlaps between two sets of genomic features.
keywords:
- bed
- intersect
tools:
- bedtools:
description: |
A set of tools for genomic analysis tasks, specifically enabling genome arithmetic (merge, count, complement) on various file types.
documentation: https://bedtools.readthedocs.io/en/latest/content/tools/intersect.html
params:
- outdir:
type: string
description: |
The pipeline's output directory. By default, the module will
output files into `$params.outdir/<SOFTWARE>`
- publish_dir_mode:
type: string
description: |
Value for the Nextflow `publishDir` mode parameter.
Available: symlink, rellink, link, copy, copyNoFollow, move.
- enable_conda:
type: boolean
description: |
Run the module with Conda using the software specified
via the `conda` directive
- singularity_pull_docker_container:
type: boolean
description: |
Instead of directly downloading Singularity images for use with Singularity,
force the workflow to pull and convert Docker containers instead.
input:
- meta:
type: map
description: |
Groovy Map containing sample information
e.g. [ id:'test', single_end:false ]
- bed1:
type: file
description: BED file, each feature in 1 is compared to 2 in search of overlaps
pattern: "*.{bed}"
- bed2:
type: file
description: Second bed file, used to compare to first BED file
pattern: "*.{bed}"
output:
- meta:
type: map
description: |
Groovy Map containing sample information
e.g. [ id:'test', single_end:false ]
- bed:
type: file
description: BED file with intersected intervals
pattern: "*.{bed}"
- version:
type: file
description: File containing software version
pattern: "*.{version.txt}"
authors:
- "@Emiller88"
- "@sruthipsuresh"
- "@drpatelh"