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 bluster functions to cheatsheet #814

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

sjspielman
Copy link
Member

@sjspielman sjspielman commented Nov 27, 2024

Closes #813

This PR adds bluster functions used in the (forthcoming) exercise notebook to the scRNA-seq-advanced.

A couple additional questions:

  • I also realized we don't have bluster in the scRNA-seq cheatsheet. Should I go ahead and add clusterRows() there too?
  • I haven't done ☝️ (yet) in case we think I should also add NNGraphParam() (and/or KGraphParam() KMeansParam() which is also used in the scRNA-seq module), so I'll do this all in one go if we want to add more!

@sjspielman
Copy link
Member Author

Given https://github.com/AlexsLemonade/exercise-notebook-answers/pull/228/files#r1861067009, I'm thinking I should go ahead and add NNGraphParam() and KGraphParam().

@jashapiro
Copy link
Member

jashapiro commented Dec 2, 2024

Given https://github.com/AlexsLemonade/exercise-notebook-answers/pull/228/files#r1861067009, I'm thinking I should go ahead and add NNGraphParam() and KGraphParam() KMeansParam()*.

I was just about to say this. And you may as well add it to the scRNA-seq cheatsheet while you are doing this.

@sjspielman
Copy link
Member Author

@jashapiro done!

Copy link
Member

@jashapiro jashapiro left a comment

Choose a reason for hiding this comment

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

I did a bit of rewording, and fixed a function name. See what you think of the rewords.

| Library/Package | Piece of Code | What it's called | What it does |
|----------------------|--------------------|---------------------|---------------|
| `bluster`| [`clusterRows()`](https://rdrr.io/bioc/bluster/man/clusterRows.html)| Cluster rows of a matrix | Perform clustering using a variety of algorithms on a matrix-like object |
| `bluster`| [`KGraphParam()`](https://rdrr.io/bioc/bluster/man/KmeansParam-class.html)| K-means clustering | Run k-means clustering using `kmeans()` when provided to `bluster::clusterRows()` |
Copy link
Member

Choose a reason for hiding this comment

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

Clustering function name fix, as well as a clarification that this function only sets up parameters.

Suggested change
| `bluster`| [`KGraphParam()`](https://rdrr.io/bioc/bluster/man/KmeansParam-class.html)| K-means clustering | Run k-means clustering using `kmeans()` when provided to `bluster::clusterRows()` |
| `bluster`| [`KmeansParam()`](https://rdrr.io/bioc/bluster/man/KmeansParam-class.html)| K-means clustering parameters | Set up parameters to run clustering using `kmeans()` within `bluster::clusterRows()` |

|----------------------|--------------------|---------------------|---------------|
| `bluster`| [`clusterRows()`](https://rdrr.io/bioc/bluster/man/clusterRows.html)| Cluster rows of a matrix | Perform clustering using a variety of algorithms on a matrix-like object |
| `bluster`| [`KGraphParam()`](https://rdrr.io/bioc/bluster/man/KmeansParam-class.html)| K-means clustering | Run k-means clustering using `kmeans()` when provided to `bluster::clusterRows()` |
| `bluster`| [`NNGraphParam()`](https://rdrr.io/bioc/bluster/man/NNGraphParam-class.html)| Graph-based clustering | Run community detection algorithms on a nearest-neighbor (NN) graph when provided to `bluster::clusterRows()` |
Copy link
Member

Choose a reason for hiding this comment

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

possible rephrasing

Suggested change
| `bluster`| [`NNGraphParam()`](https://rdrr.io/bioc/bluster/man/NNGraphParam-class.html)| Graph-based clustering | Run community detection algorithms on a nearest-neighbor (NN) graph when provided to `bluster::clusterRows()` |
| `bluster`| [`NNGraphParam()`](https://rdrr.io/bioc/bluster/man/NNGraphParam-class.html)| Graph-based clustering parameters | Set up parameters for nearest-neighbor (NN) graph-based clustering algorithms to be applied within `bluster::clusterRows()` |

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.

Add cluster evaluation functions to scRNA-seq-advanced cheatsheet
2 participants