nf-core_modules/modules/idr/meta.yml

name: idr
description: |
  Measures reproducibility of ChIP-seq, ATAC-seq peaks using IDR (Irreproducible
  Discovery Rate)
keywords:
  - IDR
  - peaks
  - ChIP-seq
  - ATAC-seq
tools:
  - idr:
      description: |
        The IDR (Irreproducible Discovery Rate) framework is a unified approach
        to measure the reproducibility of findings identified from replicate
        experiments and provide highly stable thresholds based on reproducibility.
      homepage: None
      documentation: None
      tool_dev_url: https://github.com/kundajelab/idr
      doi: ""
      licence: ['GPL v2']
input:
  - peaks:
      type: tuple of two files
      description: BED, narrowPeak or broadPeak files of replicates
      pattern: "*"
  - peak_type:
      type: value
      description: Type of peak file
      pattern: "{narrowPeak,broadPeak,bed}"
  - prefix:
      type: value
      description: Prefix for output files
output:
  - versions:
      type: file
      description: File containing software versions
      pattern: "versions.yml"
  - idr:
      type: file
      description: Text file containing IDR values
      pattern: "*.{txt}"
  - log:
      type: file
      description: Log file
      pattern: "*.{txt}"
  - png:
      type: file
      description: Plot generated by idr
      pattern: "*{.png}"

authors:
  - "@drpatelh"
  - "@joseespinosa"