-
-
Notifications
You must be signed in to change notification settings - Fork 28
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
base: master
Are you sure you want to change the base?
Conversation
Given https://github.com/AlexsLemonade/exercise-notebook-answers/pull/228/files#r1861067009, I'm thinking I should go ahead and add |
I was just about to say this. And you may as well add it to the scRNA-seq cheatsheet while you are doing this. |
@jashapiro done! |
There was a problem hiding this 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()` | |
There was a problem hiding this comment.
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.
| `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()` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
possible rephrasing
| `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()` | |
Closes #813
This PR adds bluster functions used in the (forthcoming) exercise notebook to the
scRNA-seq-advanced
.A couple additional questions:
bluster
in thescRNA-seq
cheatsheet. Should I go ahead and addclusterRows()
there too?NNGraphParam()
(and/orKGraphParam()
KMeansParam()
which is also used in thescRNA-seq
module), so I'll do this all in one go if we want to add more!