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

Xenome: show percentages by default, add table and sections #2164

Merged
merged 7 commits into from
Nov 8, 2023

Conversation

vladsavelyev
Copy link
Member

@vladsavelyev vladsavelyev commented Nov 7, 2023

Few adjustments to the Xenome module based on the feedback from @tamuanand (including #1860 (comment))

  1. In the table columns and plots, showing the percentages by default:
Screenshot 2023-11-07 at 18 31 54
  1. Added a summary table in addition to the general stats columns. Added there hidden columns for read counts.

  2. Properly added section wrappers to the plots to make sure they appear in the contents panel.

  3. Additionally, making sure that the color scales for species in the table match the colors in the bar plot.

@vladsavelyev vladsavelyev added module: change awaits-review Awaiting final review and merge. labels Nov 7, 2023
@vladsavelyev vladsavelyev added this to the MultiQC v1.18 milestone Nov 7, 2023
Copy link
Contributor

github-actions bot commented Nov 7, 2023

🚀 Deployed on https://mqc-pr-2164--multiqc.netlify.app

@vladsavelyev vladsavelyev changed the title Xenome: show percentages by default Xenome: show percentages by default, add table and sections Nov 7, 2023
@tamuanand
Copy link

Thanks a ton @vladsavelyev for working on this.

@tamuanand
Copy link

@vladsavelyev One suggestion - to add to the multiqc docs for xenome

xenome classify outputs useful stats to stderr/stdout

  • hence once has to redirect command line output to a sample_name.xenome_stats.txt file for MultiQC to parse this useful info (very much like how it is done for kallisto - https://mqc-pr-2164--multiqc.netlify.app/modules/kallisto/)
  • also the tool does not register any sample name info in this stderr/stdout - hence it is very important to correctly name the stdout/stderr file
  • do not do this - naming the stdout/stderr file as xenome_stats.txt without any sample name prefix would lead to input file collision when one is bringing together files from xenome runs on multiple samples and then running multiqc on it

Copy link
Member

@ewels ewels left a comment

Choose a reason for hiding this comment

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

LGTM to merge after the suggested docs additions are made 👍🏻

@tamuanand
Copy link

@vladsavelyev is this available in a dev version that I can try out after installing with pip like this?

pip install --upgrade --force-reinstall git+https://github.com/ewels/MultiQC.git

@vladsavelyev
Copy link
Member Author

@tamuanand, after the PR is merged - yes. Before that, you would need to specify the branch name as well:

pip install --upgrade --force-reinstall git+https://github.com/ewels/MultiQC.git@xenome

If you do it often though, it's convenient to keep a clone of the repo locally:

git clone https://github.com/ewels/MultiQC.git

And run pip install -e MultiQC, so the multiqc installation uses the exact locally cloned code base in the MultiQC folder.

You can optionally check out a specific branch:

cd MultiQC
git checkout xenome

And you installation will switch into it automatically without need to do pip install again.

@vladsavelyev vladsavelyev merged commit c62a430 into master Nov 8, 2023
7 checks passed
@vladsavelyev vladsavelyev deleted the xenome branch November 8, 2023 13:28
@tamuanand tamuanand mentioned this pull request Nov 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaits-review Awaiting final review and merge. module: change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants