Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multiqc #88

Merged
merged 65 commits into from
Jun 17, 2024
Merged

Multiqc #88

merged 65 commits into from
Jun 17, 2024

Conversation

LouisLeNezet
Copy link
Collaborator

Improve the output of multiqc and add more statistics.

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/phaseimpute branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

@LouisLeNezet LouisLeNezet self-assigned this Jun 11, 2024
@LouisLeNezet LouisLeNezet added the enhancement New feature or request label Jun 11, 2024
@LouisLeNezet LouisLeNezet added this to the v0.99.0 milestone Jun 11, 2024
@LouisLeNezet LouisLeNezet linked an issue Jun 11, 2024 that may be closed by this pull request
@LouisLeNezet LouisLeNezet marked this pull request as ready for review June 12, 2024 15:37
@LouisLeNezet LouisLeNezet requested a review from atrigila June 12, 2024 15:37
Copy link
Collaborator

@atrigila atrigila left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job. A question can the general statistics be split in sections for each of the major subworkflows? So that when the user browses the report they can see if the statistics are before/after imputation.

assets/schema_input.json Outdated Show resolved Hide resolved
conf/modules.config Outdated Show resolved Hide resolved
conf/steps/imputation_glimpse2.config Show resolved Hide resolved
@LouisLeNezet
Copy link
Collaborator Author

Hi @atrigila !
I've tried to split by step using the following in the multiqc_config.yml.

run_modules:
    - "samtools"
    - "bcftools"

top_modules:
    - "samtools"
    - "bcftools":
        name: "BCFtools (original VCF)"
        info: "BCFtools stats of original files"
        path_filters:
            - "*.panel.bcftools_stats.txt"
            - "*.truth.bcftools_stats.txt"
    - "bcftools":
        name: "BCFtools (imputed VCF)"
        info: "BCFtools stats of imputed files"
        path_filters:
            - "*.glimpse1.bcftools_stats.txt"
            - "*.glimpse2.bcftools_stats.txt"
            - "*.stitch.bcftools_stats.txt"
            - "*.quilt.bcftools_stats.txt"

This does separate the section by step but the general statistic table is then messed up.
image
So for the moment I think it is preferable to keep everything together.
It also allows to easy compare the truth to the imputed files.

@LouisLeNezet LouisLeNezet merged commit 20956e6 into nf-core:dev Jun 17, 2024
8 checks passed
@LouisLeNezet LouisLeNezet deleted the multiqc branch October 1, 2024 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

MULTIQC report per sample
3 participants