ccb-hms / scDiagnostics

Diagnostic functions to assess the quality of cell type annotations in single-cell RNA-seq data
https://ccb-hms.github.io/scDiagnostics/
3 stars 2 forks source link

scDiagnostics: diagnostic functions to assess the quality of cell type annotations in single-cell RNA-seq data

BioC release version

Overview

The accurate annotation of cell types is a critical step in single-cell RNA-sequencing (scRNA-seq) analysis. While annotation transfer from a reference dataset offers a convenient and automated approach, it can also introduce biases and errors if not performed carefully.

scDiagnostics is an R package designed to address this challenge by providing a comprehensive set of diagnostic tools for evaluating the quality of cell type annotations in scRNA-seq data. With scDiagnostics, researchers can systematically assess the compatibility and accuracy of annotations, ensuring reliable and reproducible results in their scRNA-seq analysis workflow.

Installation

Installation from Bioconductor (Release)

Users interested in using the stable release version of the scDiagnostics package: please follow the installation instructions here. This is the recommended way of installing the package.

Installation from GitHub (Development)

To install the development version of the package from GitHub use the following command:

BiocManager::install("ccb-hms/scDiagnostics")

To build the package vignettes upon installation use:

BiocManager::install("ccb-hms/scDiagnostics",
                     build_vignettes = TRUE,
                     dependencies = TRUE)

Usage

See the scDiagnostics website for an overview of the functionality of the package. The individual documentation of each available function incl. usage details and executable examples is available in the reference tab.

Key Features

See the Getting Started with scDiagnostics vignette for an overview of the main functionality of the package. As listed below, additional vignettes are available for specific diagnostic tasks.