Add table with number of clusters to Ewing clustering report #938
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
README.md
has been updated to reflect code changes in this pull request.Reproducibility checklist
Dockerfile
.environment.yml
file.renv.lock
file.