nf-core_modules/modules/multiqc/meta.yml

name: MultiQC
description: Aggregate results from bioinformatics analyses across many samples into a single report
keywords:
    - QC
    - bioinformatics tools
    - Beautiful stand-alone HTML report
tools:
    - multiqc:
        description: |
            MultiQC searches a given directory for analysis logs and compiles a HTML report.
            It's a general use tool, perfect for summarising the output from numerous bioinformatics tools.
        homepage: https://multiqc.info/
        documentation: https://multiqc.info/docs/
        licence: ['GPL-3.0-or-later']
input:
    - multiqc_files:
        type: file
        description: |
            List of reports / files recognised by MultiQC, for example the html and zip output of FastQC
output:
    - report:
        type: file
        description: MultiQC report file
        pattern: "multiqc_report.html"
    - data:
        type: dir
        description: MultiQC data dir
        pattern: "multiqc_data"
    - plots:
        type: file
        description: Plots created by MultiQC
        pattern: "*_data"
    - versions:
        type: file
        description: File containing software versions
        pattern: "versions.yml"
authors:
    - "@abhi18av"
    - "@bunop"
    - "@drpatelh"
Fixing MULTIQC module and adding tests (#1) * fix multiqc process * fix multiqc tests * move multiqc test input data into tests/data/fastqc/ folder Move input tests data into tests/data/fastqc/ and linking those files into software/multiqc/test/input/ as stated from the project documentation * add multiqc github workflow * remove unused file * generalize multiqc input data User must collect all desidered files in a channel (as described in https://seqera.io/training/#_multiqc_report * update meta information 2020-11-29 07:50:23 +00:00			`name: MultiQC`
			`description: Aggregate results from bioinformatics analyses across many samples into a single report`
initial attempt for multiqc module 2020-11-23 13:01:55 +00:00			`keywords:`
Fixing MULTIQC module and adding tests (#1) * fix multiqc process * fix multiqc tests * move multiqc test input data into tests/data/fastqc/ folder Move input tests data into tests/data/fastqc/ and linking those files into software/multiqc/test/input/ as stated from the project documentation * add multiqc github workflow * remove unused file * generalize multiqc input data User must collect all desidered files in a channel (as described in https://seqera.io/training/#_multiqc_report * update meta information 2020-11-29 07:50:23 +00:00			`- QC`
			`- bioinformatics tools`
			`- Beautiful stand-alone HTML report`
initial attempt for multiqc module 2020-11-23 13:01:55 +00:00			`tools:`
Fixing MULTIQC module and adding tests (#1) * fix multiqc process * fix multiqc tests * move multiqc test input data into tests/data/fastqc/ folder Move input tests data into tests/data/fastqc/ and linking those files into software/multiqc/test/input/ as stated from the project documentation * add multiqc github workflow * remove unused file * generalize multiqc input data User must collect all desidered files in a channel (as described in https://seqera.io/training/#_multiqc_report * update meta information 2020-11-29 07:50:23 +00:00			`- multiqc:`
initial attempt for multiqc module 2020-11-23 13:01:55 +00:00			`description: \|`
Fixing MULTIQC module and adding tests (#1) * fix multiqc process * fix multiqc tests * move multiqc test input data into tests/data/fastqc/ folder Move input tests data into tests/data/fastqc/ and linking those files into software/multiqc/test/input/ as stated from the project documentation * add multiqc github workflow * remove unused file * generalize multiqc input data User must collect all desidered files in a channel (as described in https://seqera.io/training/#_multiqc_report * update meta information 2020-11-29 07:50:23 +00:00			`MultiQC searches a given directory for analysis logs and compiles a HTML report.`
			`It's a general use tool, perfect for summarising the output from numerous bioinformatics tools.`
			`homepage: https://multiqc.info/`
			`documentation: https://multiqc.info/docs/`
Backfill software licenses meta (#876) * backfilled modules with meta.yml that had no license identifier * harmonized BSD license names * whitespace linting at modules/unzip/meta.yml:12 * harmonized software from US NIH-NCBI/NIST to 'US-Government-Work' * Update modules/bcftools/index/meta.yml `bcftools` is dual-licensed, use associative array to allow for multiple licenses Co-authored-by: Michael L Heuer <heuermh@acm.org> Co-authored-by: Michael L Heuer <heuermh@acm.org> 2021-10-22 22:39:54 +00:00			`licence: ['GPL-3.0-or-later']`
initial attempt for multiqc module 2020-11-23 13:01:55 +00:00			`input:`
Apply suggestions from code review by @drpatelh Co-authored-by: Harshil Patel <drpatelh@users.noreply.github.com> 2020-12-08 13:27:14 +00:00			`- multiqc_files:`
initial attempt for multiqc module 2020-11-23 13:01:55 +00:00			`type: file`
			`description: \|`
Apply suggestions from code review by @drpatelh Co-authored-by: Harshil Patel <drpatelh@users.noreply.github.com> 2020-12-08 13:27:14 +00:00			`List of reports / files recognised by MultiQC, for example the html and zip output of FastQC`
initial attempt for multiqc module 2020-11-23 13:01:55 +00:00			`output:`
Give finishing touches after the review 2020-12-08 13:38:00 +00:00			`- report:`
			`type: file`
			`description: MultiQC report file`
			`pattern: "multiqc_report.html"`
Apply suggestions from code review by @drpatelh Co-authored-by: Harshil Patel <drpatelh@users.noreply.github.com> 2020-12-08 13:27:14 +00:00			`- data:`
Fixing MULTIQC module and adding tests (#1) * fix multiqc process * fix multiqc tests * move multiqc test input data into tests/data/fastqc/ folder Move input tests data into tests/data/fastqc/ and linking those files into software/multiqc/test/input/ as stated from the project documentation * add multiqc github workflow * remove unused file * generalize multiqc input data User must collect all desidered files in a channel (as described in https://seqera.io/training/#_multiqc_report * update meta information 2020-11-29 07:50:23 +00:00			`type: dir`
			`description: MultiQC data dir`
			`pattern: "multiqc_data"`
Give finishing touches after the review 2020-12-08 13:38:00 +00:00			`- plots:`
initial attempt for multiqc module 2020-11-23 13:01:55 +00:00			`type: file`
Give finishing touches after the review 2020-12-08 13:38:00 +00:00			`description: Plots created by MultiQC`
			`pattern: "*_data"`
Update versions key in meta.yml for all modules (#787) 2021-10-03 07:20:26 +00:00			`- versions:`
initial attempt for multiqc module 2020-11-23 13:01:55 +00:00			`type: file`
Update versions key in meta.yml for all modules (#787) 2021-10-03 07:20:26 +00:00			`description: File containing software versions`
Update fastqc to produce multi-version versions.yml (#665) * Update fastqc to produce multi-version versions.yml * Update readme and pull request template * Fix markdownlint * remove variable * Change publish dir to lowercase * Re-add getSoftwareName * Add custom pytest-workflow test to ensure versions.yml is valid * Add docstring * Remove __init__.py as it is not needed * Remove changes to README, since this part went to nf-co.re * Add NF_CORE_TEST env var * Fix editorconfig * Add additional consistency checks for versions.yml * Update multiqc module * Fix output channel 2021-09-24 09:01:54 +00:00			`pattern: "versions.yml"`
initial attempt for multiqc module 2020-11-23 13:01:55 +00:00			`authors:`
Fixing MULTIQC module and adding tests (#1) * fix multiqc process * fix multiqc tests * move multiqc test input data into tests/data/fastqc/ folder Move input tests data into tests/data/fastqc/ and linking those files into software/multiqc/test/input/ as stated from the project documentation * add multiqc github workflow * remove unused file * generalize multiqc input data User must collect all desidered files in a channel (as described in https://seqera.io/training/#_multiqc_report * update meta information 2020-11-29 07:50:23 +00:00			`- "@abhi18av"`
			`- "@bunop"`
Give finishing touches after the review 2020-12-08 13:38:00 +00:00			`- "@drpatelh"`