Comments (12)
While MultiQC is indeed a natural choice for aggregation of QC metrics and statistics, I wonder if it's appropriate here. MultiQC usually takes the pre-defined output of specific tools; the output of the reports and their content is not from a single tool and might change in the future. I'm thinking that an additional Quarto report might be more appropriate here, but this can certainly be discussed. Thoughts, @cavenel ?
from spatialvi.
I'm open to both solutions. It will definitely be quicker to get something up and running with another quarto report. It might also need quite some custom code for parsing summary statistics, and at some point better to have a separate package.
For additional context, for single-cell data, there's the checkatlas package which generates a MultiQC report, and we're considering to add it to the #scrnaseq pipeline (nf-core/scrnaseq#80). Here's an example report:
https://checkatlas.readthedocs.io/en/stable/CheckAtlas_example_2/CheckAtlas_example_2.html
So one option could be to make a similar package, or add spatial support to checkatlas.
CC @drbecavin
from spatialvi.
I do like the general idea of using MultiQC, if only because it's so common for nf-core pipelines, but it's probably a lot more effort. While getting another Quarto report might be a good solution for now, it can certainly be discussed whether to spend the effort to create some interface for MultiQC in the future. As it is, the current Quarto reports could also get some additional work and prettifying in addition to what we already have.
I hadn't seen checkatlas before, thanks for sharing! Using something that already exists is always a good solution, if it can interface with spatial stuff.
from spatialvi.
I like the idea of using checkatlas, as it can generate the MultiQC output directly from the AnnData outputs of all samples. I wonder what kind of extra QC we could add from spatial though.
Maybe as a first step, adding checkatlas as is would already be nice!
from spatialvi.
I wonder, if the multiqc cellranger module could directly work with spaceranger html reports as well. This multiqc module focues more on alignment statistics, so it would be valuable to have in addition to checkatlas.
from spatialvi.
I wonder, if the multiqc cellranger module could directly work with spaceranger html reports as well
It doesn't, but it should be relatively straightfoward to adapt its code to add a separate spaceranger module to multiqc. Maybe I can look into that.
My plan for improving QC for spatialtranscriptomics:
- Add MultiQC and FastQC to setup a basic QC workflow
- implement spaceranger module in multiqc
- look into custom content for multiqc reports or checkatlas
from spatialvi.
Getting a Space Ranger module for MultiQC would be nice! That coupled with some custom content from the reports would be a nice starting point to build on.
from spatialvi.
MultiQC module is ready, waiting for review: MultiQC/MultiQC#1945
from spatialvi.
I have recently tried your spaceranger multiqc module. The multiqc report looks very nice. I just want to ask that is it possible to also include the "Gene and UMI Distribution" violin plot in the 10X report and parse it into multiqc_report as a normal boxplot? Thank you. @grst
from spatialvi.
Multiqc module now released: https://github.com/MultiQC/MultiQC/releases/tag/v1.21
from spatialvi.
Where are we on this issue at the moment? The MultiQC Space Ranger module works great for that, but obviously only contains the Space Ranger-specific QC metrics. Given that checkatlas does not seem to be a simple solution plus seemingly not being maintained (last update was 9 months ago) that's probably not the way to go. Adding another Quarto report to collect some of the plots could be something that might help provide an overview of the downstream analyses. Other ideas?
from spatialvi.
I've seen some activity on checkatlas in the issue tracker lately, but I agree it's not a short-term solution. I think it would be nice if any other QC metrics would be part of the multiqc report, to have a single location to check. This would be possible via a custom script + multiqc custom content.
Overall I think the spaceranger metrics are already quite helpful, more would be nice, but not sure it's high priority.
from spatialvi.
Related Issues (20)
- Create outputs readable by e.g. TissUUmaps, Loupe
- Module compilation error - cause: unable to resolve class JsonSlurper HOT 2
- Module compilation error HOT 2
- Add documentation for "Analysis options" in `usage.md` HOT 1
- Is Space Ranger Cytassist supported? HOT 2
- Implement tests using nf-test HOT 1
- Update spaceranger to 2.x HOT 8
- It should be possible to provide manual image alignments on a per-sample basis
- Add SpatialData as output HOT 20
- Add checks for QC filtering HOT 2
- Auto-detection of samplesheet type HOT 1
- Full-size test dataset
- Version exporting of `leidenalg` and `SpatialDE` does not work
- Aggregate samples into single object HOT 4
- Rename the pipeline HOT 1
- Missing SpatialDE package in Docker container for ST_SPATIAL_DE process HOT 3
- Use `to_legacy_anndata` function from `spatialdata_io` instead of custom code HOT 1
- Option to use the `--unknown-slide` parameter in `spaceranger count`
- MultiQC 1.21 doesn't support genomic_dna section
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from spatialvi.