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

Improve reporting #2

Open
nictru opened this issue Jun 13, 2024 · 1 comment
Open

Improve reporting #2

nictru opened this issue Jun 13, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@nictru
Copy link
Contributor

nictru commented Jun 13, 2024

Description of feature

Example reporting has already been implemented here. scFlow had really nice reports that should be used as inspiration (can be viewed here).

@nictru nictru added the enhancement New feature or request label Jun 13, 2024
@nictru nictru added this to the Stable transcriptomics milestone Jun 13, 2024
@nictru
Copy link
Contributor Author

nictru commented Jul 15, 2024

If you want to contribute here, adding plots of the UMAP representations of the integrations to the report would be a good starting point. UMAP creation currently happens in this module, more specifically in this script. After this line, the X_umap obsm field will contain the proper representation that can directly used for plotting.

Plotting itself should not be much of a problem. Make sure to use ${prefix}.png as the plot file name. In order to properly add the plots to the multiQC report, some additional steps are required:

  1. Create a json file like it is done here
  2. Change the output definition of the UMAP process so that the png and json are emitted properly (example)
  3. Add a new channel to the CLUSTER subworkflow called ch_multiqc_files like here. Make sure to mix in the json outputs and emit the channel in the end of the CLUSTER subworkflow
  4. Mix the subworkflow ch_multiqc_files into the global one like here
  5. If necessary, adjust the multiQC config. General information on MultiQC can be found in the docs.

PS:
Because of the way the CLUSTER subworkflow is structured, you can be sure that the neighborhood graph that is used as a base for UMAP creation is based on the correct embeddings.

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

No branches or pull requests

1 participant