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

Add table with number of clusters to Ewing clustering report #938

Merged

Conversation

allyhawkins
Copy link
Member

Purpose/implementation Section

Please link to the GitHub issue that this pull request addresses.

Closes #935

What is the goal of this pull request?

Here I'm adding a table that summarizes the number of clusters for each set of parameters used for clustering in 01-clustering-metrics.Rmd.

Briefly describe the general approach you took to achieve this goal.

Before reporting any stats there should now be a print out of the number of clusters for all parameters used. I also added a sentence stating that if there was only one cluster there would be no distributions shown.
The tables aren't super fancy or anything but I think they do the job and are readable.

If known, do you anticipate filing additional pull requests to complete this analysis module?

Yes

Results

What is the name of your results bucket on S3?

s3://researcher-211125375652-us-east-2/cell-type-ewings/results/clustering

What types of results does your code produce (e.g., table, figure)?

Rendered reports for each sample. Note that I will re-run the workflow and update the bucket once these changes are approved.

What is your summary of the results?

No changes to the results with this change other than the addition of the table. The conclusions are the same.

Provide directions for reviewers

What are the software and computational requirements needed to be able to run the code in this PR?

I rendered the example report locally, but running the full workflow takes ~ 24 hours on a laptop.

Are there particularly areas you'd like reviewers to have a close look at?

Here's an example of a rendered report:
01-clustering-metrics.html.zip

Author checklists

Check all those that apply.
Note that you may find it easier to check off these items after the pull request is actually filed.

Analysis module and review

Reproducibility checklist

  • Code in this pull request has been added to the GitHub Action workflow that runs this module.
  • The dependencies required to run the code in this pull request have been added to the analysis module Dockerfile.
  • If applicable, the dependencies required to run the code in this pull request have been added to the analysis module conda environment.yml file.
  • If applicable, R package dependencies required to run the code in this pull request have been added to the analysis module renv.lock file.

@allyhawkins allyhawkins requested review from sjspielman and removed request for jaclyn-taroni December 12, 2024 21:08
Copy link
Member

@sjspielman sjspielman left a comment

Choose a reason for hiding this comment

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

Woohoo!

@allyhawkins
Copy link
Member Author

The updated clustering reports have been added to S3. This already passed CI today and then new changes were added to main unrelated to this module so I'm cancelling the latest run of the workflow.

@allyhawkins allyhawkins merged commit e1daebb into AlexsLemonade:main Dec 17, 2024
1 of 3 checks passed
@allyhawkins allyhawkins deleted the allyhawkins/cluster-numbers-table branch December 17, 2024 21:07
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.

Update clustering metrics report for Ewing module to include number of clusters
2 participants