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

Merged
merged 5 commits into from
Dec 2, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion module-cheatsheets/scRNA-seq-advanced-cheatsheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ If you have a different version of R or other R packages, the documentation may

- [`scater`](#scater)
- [`miQC`](#miqc)
- [`batchelor` and `harmony`](#batchelor-and-harmony)
- [`SingleR`](#singler)
- [`pheatmap` and `EnhancedVolcano`](#pheatmap-and-enhancedvolcano)
- [`DESeq2` and pseudo-bulking functions](#deseq2-and-pseudo-bulking-functions)
Expand All @@ -33,6 +34,7 @@ If you have a different version of R or other R packages, the documentation may
- [`msigdbr`](#msigdbr)
- [`clusterProfiler` and `enrichplot`](#clusterprofiler-and-enrichplot)
- [`AUCell` and `GSEABase`](#aucell-and-gseabase)
- [`bluster`](#bluster)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand Down Expand Up @@ -219,8 +221,25 @@ Read the [`AUCell` package documentation](https://bioconductor.org/packages/rele
|-------------------------------|--------------------------------------------------------------|--------------------------------|--------------------------------------------------------------------------|
| `GSEABase` | [`GeneSet()`](https://rdrr.io/bioc/GSEABase/man/GeneSet-class.html) | Gene set | Constructs a gene set as a `GeneSet` object for use with `AUCell` |
| `GSEABase` | [`GeneSetCollection()`](https://rdrr.io/bioc/GSEABase/man/GeneSetCollection-class.html) | Gene set collection | Constructs a collection of gene sets as a `GeneSetCollection` object for use with `AUCell`
| `AUCell` | [`AUCell_buildRankings()`](https://rdrr.io/bioc/AUCell/man/AUCell_buildRankings.html) | Build cell rankings | Builds a ranking of genes for each cell that is used to calculate the recovery curve |
| `AUCell` | [`AUCell_buildRankings()`](https://rdrr.io/bioc/AUCell/man/AUCell_buildRankings.html) | Build cell rankings | Builds a ranking of genes for each cell that is used to calculate the recovery curve |
| `AUCell` | [`AUCell_calcAUC()`](https://rdrr.io/bioc/AUCell/man/AUCell_calcAUC.html) | Calculate AUC | Calculates the area under the recovery curve (AUC) for each gene set in each cell |
| `AUCell` | [`AUCell_exploreThresholds()`](https://rdrr.io/bioc/AUCell/man/AUCell_exploreThresholds.html) | Explore thresholds | Calculates thresholds in AUC values that can be used to assign cells; optionally makes assignments and produces histograms |



## `bluster`

Read the [`bluster` package documentation](https://rdrr.io/bioc/bluster/) and vignettes on its usage:

* [Flexible clustering for Bioconductor](https://rdrr.io/bioc/bluster/f/vignettes/clusterRows.Rmd)
* [Assorted clustering diagnostics](https://rdrr.io/bioc/bluster/f/vignettes/diagnostics.Rmd)


| 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()` |
sjspielman marked this conversation as resolved.
Show resolved Hide resolved
| `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()` |
sjspielman marked this conversation as resolved.
Show resolved Hide resolved
| `bluster`| [`approxSilhouette()`](https://rdrr.io/bioc/bluster/man/approxSilhouette.html)| Approximate silhouette width | Calculate an approximate silhouette width for each cell given a set of clusters |
| `bluster`| [`neighborPurity()`](https://rdrr.io/bioc/bluster/man/neighborPurity.html)| Compute neighborhood purity | Calculate neighborhood purity for each cell given a set of clusters |
| `bluster`| [`bootstrapStability()`](https://rdrr.io/bioc/bluster/man/bootstrapStability.html)| Assess cluster stability by bootstrapping | Generate cluster bootstrap replicates to estimate cluster robustness to sampling noise |
Binary file modified module-cheatsheets/scRNA-seq-advanced-cheatsheet.pdf
Binary file not shown.
15 changes: 15 additions & 0 deletions module-cheatsheets/scRNA-seq-cheatsheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ If you have a different version of R or other R packages, the documentation may
- [`SingleCellExperiment`, `txmimeta`, and `DropletUtils`](#singlecellexperiment-txmimeta-and-dropletutils)
- [`scran` and `scater`](#scran-and-scater)
- [`purrr`, `stringr`, and `tibble`](#purrr-stringr-and-tibble)
- [`bluster`](#bluster)
- [`SingleR`](#singler)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -154,6 +155,20 @@ purrr::map(

<div style="page-break-after: always;"></div>


### `bluster`

Read the [`bluster` package documentation](https://rdrr.io/bioc/bluster/) and [this vignette](https://rdrr.io/bioc/bluster/f/vignettes/clusterRows.Rmd) on its usage.


| 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()` |
| `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()` |



### `SingleR`

Read the [`SingleR` package documentation](https://rdrr.io/bioc/SingleR/), and an [e-book on its usage](http://bioconductor.org/books/release/SingleRBook/).
Expand Down
Binary file modified module-cheatsheets/scRNA-seq-cheatsheet.pdf
Binary file not shown.