Skip to content

Add neighborhood analysis module functions to cheatsheet - #1066

Merged
allyhawkins merged 6 commits into
masterfrom
allyhawkins/neighborhood-cheatsheet-updates
Aug 27, 2026
Merged

Add neighborhood analysis module functions to cheatsheet#1066
allyhawkins merged 6 commits into
masterfrom
allyhawkins/neighborhood-cheatsheet-updates

Conversation

@allyhawkins

Copy link
Copy Markdown
Member

Closes #1021

This PR updates the spatial cheatsheet to include packages/functions used in the neighborhood analysis module. This includes SpatialExperimentIO, ComplexHeatmap, and hoodscanR. Let me know if I missed anything!

While here I caught a small typo where we still mentioned using SpaceTrooper in the Xenium notebook, which we ended up taking out so I fixed that.

@allyhawkins
allyhawkins requested a review from sjspielman August 27, 2026 15:45

@sjspielman sjspielman left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This all looks good to me, just a few comments:

  • let's also add the function scater::isOutlier()
  • I think it would be good to reorganize this so the spatial package are towards the top. For this I'd recommend moving SpatialExperimentIO and hoodscanR beneath spacexr (so you'll want to re-doctoc too)

@allyhawkins

Copy link
Copy Markdown
Member Author

I made the adjustments, which included adding scuttle::isOutlier to the docs. It looks like rddr.io only has isOutlier as part of scuttle and not scater so I made that adjustment in the notebooks too.

@allyhawkins
allyhawkins requested a review from sjspielman August 27, 2026 19:55

@sjspielman sjspielman left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM! One additional change needed to make the cheatsheet (and rendered pdf) say scuttle too if that's how we're using it in the notebook, but I don't need to see it again.

| `scran`| [`getTopHVGs()`](https://rdrr.io/bioc/scran/man/getTopHVGs.html)| Get top highly variable genes | Identify variable genes in a `SingleCellExperiment` object, based on variance |
| `scran`| [`modelGeneVar()`](https://rdrr.io/bioc/scran/man/modelGeneVar.html)| model per gene variance | Model the per gene variance of a `SingleCellExperiment` object |
| `scran`| [`clusterCells()`](https://rdrr.io/github/MarioniLab/scran/man/clusterCells.html)| Cluster cells | Perform clustering on an SCE object using the `bluster` package |
| `scater`| [`isOutlier()`](https://rdrr.io/bioc/scuttle/man/isOutlier.html)| Identify outliers | Convenience function to determine which values in a numeric vector are outliers based on the median absolute deviation (MAD) |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I assume you mean for this to be scuttle? Also, would want to move this higher up in the table to be with the other scuttles.

@allyhawkins
allyhawkins merged commit 0c4ce41 into master Aug 27, 2026
5 checks passed
@allyhawkins
allyhawkins deleted the allyhawkins/neighborhood-cheatsheet-updates branch August 27, 2026 22:36
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 spatial cheatsheet with information from neighborhood analysis

2 participants