Skip to content

Commit

Permalink
Clean up documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
igordot committed Jan 8, 2024
1 parent 44057fb commit 82e96ba
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The clustermole R package (available on [CRAN](https://cran.r-project.org/packag
It includes three primary features:

* a meta-database of human and mouse markers for thousands of cell types
* cell type prediction based on marker genes
* cell type prediction based on the full expression matrix
* cell type prediction based on a set of marker genes
* cell type prediction based on a table of expression values

Check the [documentation website](https://igordot.github.io/clustermole/) for more information.
6 changes: 3 additions & 3 deletions vignettes/clustermole-intro.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ options(pillar.min_title_chars = 10)

## Overview

The clustermole R package is designed to simplify the assignment of cell type labels to scRNA-seq clusters.
The clustermole R package is designed to simplify the assignment of cell type labels to unknown cell populations, such as scRNA-seq clusters.
It provides methods to query cell identity markers sourced from a variety of databases.
The package includes three primary features:

* a meta-database of human and mouse markers for thousands of cell types (`clustermole_markers()`)
* cell type prediction based on marker genes (`clustermole_overlaps()`)
* cell type prediction based on the full expression matrix (`clustermole_enrichment()`)
* cell type prediction based on a set of marker genes (`clustermole_overlaps()`)
* cell type prediction based on a table of expression values (`clustermole_enrichment()`)

## Setup

Expand Down

0 comments on commit 82e96ba

Please sign in to comment.