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

scanpy qc plots #312

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

ajroura22
Copy link

Description

Introducing some additional QC plots for scanpy.

Fixes # (issue)

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist

  • I have made any required changes to upstream dependencies for a tool wrapper, and they are available in distribution channels (e.g. Pip, Conda).
  • If I have updated the underlying software for a tool wrapper (e.g. scanpy-scripts by changing the value of @TOOL_VERSION@), then I have reset all 'build' values to 0 (e.g. @TOOL_VERSION@+galaxy0)
  • If I have updated a tool wrapper without a software change, then I have bumped the associated 'build' values (e.g. @TOOL_VERSION@+galaxy0 @TOOL_VERSION@+galaxy1). It is acceptable to do this as well when the cli version changed but not the underlying tool (to avoid issues in the coming point).
  • If I changed the version, the @TOOL_VERSION@ part of the version does not contain any + symbols within, otherwise this will break tool ordering on the interface and the default tool being picked. Tool version should always conform to PEP440 to avoid this issue. The only + should be the one preceding galaxy<build> (unless that all the versions from that tool previously followed a different pattern).

Comment on lines +33 to +43
<param type="text" name="sample_field" label="Sample Field" />
<param type="select" name="output_format" label="Output Format">
<option value="pdf">PDF</option>
<option value="png">PNG</option>
</param>
<param type="text" name="plot_size" label="Plot Size (Width Height)" value="10,10"/>
<param type="text" name="percent_mito_field" label="Mitochondrial Gene Field" />
<param type="text" name="percent_ribo_field" label="Ribosomal Gene Field" />
<param type="text" name="ribo_field" label="Ribo Field" />
<param type="text" name="mito_field" label="Mito Field" />
<param type="text" name="doublet_score_field" label="Doublet Score Field" />
Copy link
Member

Choose a reason for hiding this comment

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

Please add a help field on each, explaining what they are. For example, for Mitochondrial Gene Field:

<param ... help="This is the field in the andata.obs pandas dataframe where the mitochondrial status of a gene is stored, usually mito"/>

Comment on lines 46 to 47
<data name="general_qc_plots" format="pdf" label="General QC Plots" />
<!-- Add more output parameters as needed -->
Copy link
Member

Choose a reason for hiding this comment

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

We need to add all the outputs (pdf or pngs) of the script. It is more entries in the part.

The reference for how to add outputs is here.

@pcm32
Copy link
Member

pcm32 commented May 7, 2024

Example of results that need to be captured in the output part:

image

@pcm32 pcm32 force-pushed the feature/scanpy_qc_plots branch from 43ded9d to 873197a Compare October 14, 2024 12:26
@pcm32 pcm32 changed the base branch from develop to main October 14, 2024 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants