Skip to content
/ chevreul Public

Set of tools for interacting with singlecellexperiment objects as projects

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md
Notifications You must be signed in to change notification settings

whtns/chevreul

Repository files navigation

Chevreul

This package includes a set of Shiny apps for exploring single cell RNA datasets processed as a SingleCellExperiment

A demo using a human gene transcript dataset from Shayler et al. (link) is available here

There are also convenient functions for:

  • Clustering and Dimensional Reduction of Raw Sequencing Data.
  • Integration and Label Transfer
  • Louvain Clustering at a Range of Resolutions
  • Cell cycle state regression and labeling

[!WARNING] Chevreul was designed for full-length smart-seq based single cell data. Default settings may not be appropriate for droplet (10x) data, though most can be adjusted. Keep in mind best practices regarding normalization, dimensional reduction, etc. when using.

Installation

You can install the released version of chevreul from github with:

Install locally and run in three steps:

You can install chevreul locally using the following steps:

install.packages("devtools")
devtools::install_github("whtns/chevreul")
chevreul::create_project_db()

You can also customize the ___location of the app using these steps:

devtools::install_github("whtns/chevreul")
chevreul::create_project_db(destdir = "/your/path/to/app")

Getting Started

First, load Chevreul and all other packages required

library(chevreul)
library(SingleCellExperiment)
library(tidyverse)
library(ggraph)

TLDR

Chevreul provides a single command to:

  • construct a SingleCellExperiment object

  • filter genes by minimum expression and ubiquity

  • normalize and scale expression by any of several methods packaged in SingleCellExperiment

Run clustering on a single object

By default clustering will be run at ten different resolutions between 0.2 and 2.0. Any resolution can be specified by providing the resolution argument as a numeric vector.

clustered_object <- clustering_workflow(chevreul_sce,
    experiment_name = "object_hu_trans",
    organism = "human"
)

Get a first look at a processed dataset using an interactive shiny app

minimalSceApp(chevreul_sce)

About

Set of tools for interacting with singlecellexperiment objects as projects

Resources

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages