Learn R Programming

sleuth

sleuth is a program for differential analysis of RNA-Seq data. It makes use of quantification uncertainty estimates obtained via kallisto for accurate differential analysis of isoforms or genes, allows testing in the context of experiments with complex designs, and supports interactive exploratory data analysis via sleuth live. The sleuth methods are described in

H Pimentel, NL Bray, S Puente, P Melsted and Lior Pachter, Differential analysis of RNA-seq incorporating quantification uncertainty, Nature Methods (2017), advanced access.

Scripts reproducing all the results of the paper are available here.

Installation

The easiest way to install is using the devtools package through Bioconductor.

source("http://bioconductor.org/biocLite.R")
biocLite("devtools")    # only if devtools not yet installed
biocLite("pachterlab/sleuth")

These commands will install sleuth along with all of its dependencies. You can then load sleuth like any other R package:

library('sleuth')

Installation via conda

If you have conda, a cross-platform package manager installed, you can install sleuth via the bioconda channel.

conda install --channel bioconda r-sleuth

Documentation

We recommend starting with the vignette:

vignette('intro', package = 'sleuth')

Detailed documentation can be retrieved within R using the help() command:

help(package = 'sleuth')

Specific function documentation can also be accessed using ? as you would for any other function in R:

?sleuth_prep

Conventions

  • All sleuth "core" functionality is prefixed by sleuth_ (e.g.

sleuth_prep()).

  • All sleuth plots are prefixed with plot_ (e.g. plot_ma())

Further help

Please visit the sleuth website for ways to get help. We have several new walk-throughs at the main sleuth website. In particular, you might find the kallisto-sleuth users Google group helpful.

Please post bug reports on GitHub.

Copyright

Copyright (C) 2017 Harold Pimentel, Nicolas Bray, Pall Melsted, Lior Pachter

Copy Link

Version

Version

0.30.0

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Last Published

February 7th, 2020

Functions in sleuth (0.30.0)

extract_model

Extract a model from a sleuth object
get_bootstrap_summary

bootstrap summary
plot_group_density

Plot density
plot_loadings

Plot Loadings and Interpretations
plot_sample_heatmap

Plot sample heatmap
plot_scatter

Sample to sample scatter plot
get_bootstraps

Extract bootstrap for a specific transcript
is_kallisto_subset

Is Kallisto Object Subsetted?
get_col

Get a data.frame from all kallisto objects
norm_factors

Normalization factors
plot_bootstrap

Plot bootstrap summary
kallisto_table

Get kallisto abundance table from a sleuth object
plot_volcano

Plot volcano plot
plot_fld.kallisto

Plot fragment length distribution
print.sleuth_model

Print sleuth model
plot_fld.sleuth

Plot fragment length distribution
read_kallisto_tsv

Read kallisto plaintext output
sleuth_live

Interactive sleuth visualization with Shiny
sleuth_live_settings

settings for sleuth_live
plot_qq

QQ plot
sleuth_wt

Wald test for a sleuth model
plot_sample_density

Plot sample density
read_kallisto_h5

Read a kallisto object from an HDF5 file
read_kallisto

Read kallisto output
basic_filter

Basic row filter
sleuth_deploy

deploy a sleuth object
sleuth_save

save a sleuth object
transform_fun_tpm<-

Change sleuth transform TPM function
subset_kallisto

Subset a kallisto object
sleuth_to_matrix

Convert a sleuth object to matrix
$<-.sleuth

Extend internal '$<-' for sleuth object
log_transform

Natural log and offset transformation
transform_status

Check Transform Sync Status of Sleuth Fits
models

View which models have been fit
plot_transcript_heatmap

Plot clustered heatmap
write_kallisto_hdf5

Write a kallisto object to HDF5
plot_vars

Plot technical variance versus observed variance
sleuth_fit

Fit a measurement error model
sleuth_gene_table

Create a gene table from a sleuth object
sleuth_prep

Constructor for a 'sleuth' object
sleuth_results

Extract Wald or Likelihood Ratio test results from a sleuth object
design_matrix

Extract design matrix
excluded_ids

Excluded IDs in Kallisto object
plot_ma

MA plot
plot_pc_variance

Plot PC Variance
plot_mean_var

Mean-variance relationship
plot_pca

Plot PCA
sleuth_load

load a sleuth object
sleuth_lrt

sleuth likelihood ratio test
transcripts_from_gene

Get the names of the transcripts associated to a gene
transform_fun_counts<-

Change sleuth transform counts function