Learn R Programming
⚠️There's a newer version (1.5.0) of this package.Take me there.

DeLorean (version 1.2.2)

Estimates Pseudotimes for Single Cell Expression Data

Description

Implements the DeLorean model to estimate pseudotimes for single cell expression data. The DeLorean model uses a Gaussian process latent variable model to model uncertainty in the capture time of cross-sectional data.

Copy Link

Version

Install

install.packages('DeLorean')

Monthly Downloads

13

Version

1.2.2

License

MIT + file LICENSE

Maintainer

John Reid

Last Published

May 18th, 2016

Functions in DeLorean (1.2.2)

adjust.by.cell.sizes

Adjust the expression by the estimated cell sizes.
estimate.cell.sizes

Estimate the cell sizes. We only consider genes that are expressed in a certain proportion of cells.
ordering.block.move

Move a block in an ordering and shift the other items.
ordering.invert

Invert the ordering
ordering.test.score

Test ordering score: sum every time consecutive items are in order.
pseudotime.plot

Plot pseudotime (tau) against observed capture time.
ordering.random.block.move

Randomly move a block in an ordering to another location
alpha.for.rug

Calculate a suitable value for a rug plot given the number of points
get.posterior.mean

Get posterior mean of samples
fit.held.out

Fit held out genes
plot.de.lorean

Various DeLorean object plots
process.posterior

Process the posterior, that is extract and reformat the samples from Stan. We also determine which sample has the highest likelihood, this is labelled as the 'best' sample.
magda.find.orderings

Use Magda's code to find good orderings
knit.report

Knit a report, the file inst/Rmd/.Rmd must exist in the package directory.
windram.expr

Windram et al. investigated the defense response in Arabidopsis thaliana to the necrotrophic fungal pathogen Botrytis cinerea. They collected data at 24 time points in two conditions for 30336 genes.
avg.par.samples

Average across a parameters samples.
cov.periodise

Makes a distance periodic
estimate.hyper

Estimate hyperparameters for model using empirical Bayes.
cov.calc.gene.conditioned

Calculate covariance for gene over test inputs when conditioned on data at estimated pseudotimes.
de.lorean.stylesheet

The filename of the R markdown stylesheet
gp.predictions.df

Convert the output of gp.predict() into a data.frame.
fit.dl

Perform all the steps necessary to fit the model. - prepare the data - compile the model - find suitable initialisations - fit the model using the specified method (sampling or variational Bayes) - process the posterior.
inducing.covariance

Calculate the covariance structure of the inducing points
optimise.best.sample

Optimise the best sample and update the best.sample index.
partition.de.lorean

Partition de.lorean object by cells
make.init.fn

Returns a function that constructs parameter settings with good tau.
plot.held.out.posterior

Plot the posterior of held out genes
plot.add.expr

Add expression data to a plot
ordering.improve

Improve the ordering in the sense that some function is maximised.
permuted.roughness

Permute cells and test roughness of expression.
test.fit

Test fit for log normal and gamma
cov.calc.dists

Calculate distances between vectors of time points
expected.sample.var

The expected within sample variance of a Gaussian with the given covariance.
filter.cells

Filter cells
ordering.random.move

Randomly move one item in an ordering to another location
marg.like.plot

Plot posterior for marginal log likelihoods of individual gene's expression profiles
cov.matern.32

Matern 3/2 covariance function
held.out.select.genes

Select held out genes by those with highest variance
held.out.posterior.by.variation

Order the genes by the variation of their posterior mean
filter.genes

Filter genes
make.predictions

Make predictions
find.smooth.tau

Find best order of the samples assuming some smooth GP prior on the expression profiles over this ordering.
permute.df

Permute a data frame, x. If group.col is given it should name an ordered factor that the order of the permutation should respect.
centralise

Centralises a periodic position into [period/2, period) by shifting by n*period, where n is an integer
create.ordering.ll.fn

Calculate the covariance structure of evenly spread tau and create a function that calculates the log likelihood of orderings.
examine.convergence

Analyse the samples and gather the convergence statistics. Note this only makes sense if a sampling method was used to fit the model as opposed to variational Bayes.
held.out.melt

Melt held out genes
is.de.lorean

Is a DeLorean object?
dim.de.lorean

Dimensions of DeLorean object
gene.covariances

Calculate the covariance structure of the tau
held.out.posterior

Calculate posterior covariance and estimate parameters for held out genes given pseudotimes estimated by DeLorean model.
report.file

The filename of the R markdown report.
gp.log.marg.like

The log marginal likelihood. See "2.3 Varying the Hyperparameters" on page 19 of Rasmumssen and Williams' book.
roughnesses.plot

Plot results of roughness test
gaussian.condition

Condition a Guassian on another. See Eqn. A.6 on page 200 of Rasmumssen and Williams' book.
ordering.maximise

Find a good ordering in the sense that some function is locally maximised.
aov.dl

Perform an analysis of variance to select genes for the DeLorean model.
roughness.of.sample

Calculate the roughness of the held out genes given the sample.
test.robustness.de.lorean

Test robustness of pseudotime estimation on subsets of de.lorean object
analyse.variance

Analyse variance of expression between and within capture times.
ordering.move

Move one item in an ordering and shift the other items.
tau.offsets.plot

Plot the tau offsets, that is how much the pseudotimes (tau) differ from their prior means over the full posterior.
anders.huber.cell.sizes

Estimate the cell sizes according to Anders & Huber Differential expression analysis for sequence count data
compile.model

Compile the model and cache the DSO to avoid unnecessary recompilation.
held.out.posterior.join

Join with another data frame. Useful for adding gene names etc..
expr.data.plot

Plot the expression data by the capture points
kouno.expr

Kouno et al. investigated the transcriptional network controlling how THP-1 human myeloid monocytic leukemia cells differentiate into macrophages. They provide expression values for 45 genes in 960 single cells captured across 8 distinct time points.
roughness.test

Calculate roughnesses under fit samples and also under random permutations
make.fit.valid

Make a fit valid by running one iteration of the sampler.
melt.expr

Melt an expression matrix.
analyse.noise.levels

Analyse noise levels and assess which genes have the greatest ratio of temporal variance to noise. This are labelled as the 'gene.high.psi' genes.
de.lorean

Initialise DeLorean object
gp.predict

Predictive mean, variance and log marginal likelihood of a GP. See "2.3 Varying the Hyperparameters" on page 19 of Rasmumssen and Williams' book.
calc.inducing.pseudotimes

Calculate inducing pseudotimes for sparse approximation
pseudotimes.pair.plot

Plot two sets of pseudotimes against each other.
cov.all.genes.conditioned

Calculate covariances for all genes when conditioned on data at estimated pseudotimes.
fit.model.sample

Fit the model using Stan sampler
find.best.tau

Find best tau to initialise chains with by sampling tau from the prior and using empirical Bayes parameter estimates for the other parameters.
find.good.ordering

Run a find good ordering method and append results to existing orderings
guo.expr

Single cell expression data and meta data from Guo et al. (2012). They investigated the expression of 48 genes in 500 mouse embryonic cells.
profiles.plot

Plot best sample predicted expression.
calc.roughness

Calculate the roughness of the vector. The roughness is the RMS of the differences between consecutive points.
cmp.profiles.plot

Plot a comparison of the profiles from several de.lorean objects
held.out.posterior.filter

Filter the genes
mutate.profile.data

Mutate the profile data into shape compatible with GP plot function
Rhat.plot

Plot the Rhat convergence statistics. examine.convergence must be called before this plot can be made.
default.num.cores

Default number of cores to use.
cov.calc.dl.dists

Calculate distances over estimated pseudotimes and test inputs.
fit.model

Fit the model using specified method (sampling or variational Bayes).
ordering.is.valid

Check that it is a valid ordering
roughness.of.permutations

Apply permutation based roughness test to held out genes
orderings.plot

Plot likelihoods of orderings against elapsed times taken to generate them
ordering.metropolis.hastings

Metropolis-Hastings on orderings.
prepare.for.stan

Prepare for Stan
seriation.find.orderings

Use seriation package to find good orderings
DeLorean

DeLorean.
cov.calc.gene

Calculate covariance structure for gene over pseudotimes and test inputs.
fit.model.vb

Fit the model using Stan variational Bayes
plot.add.mean.and.variance

Add posterior representation to a plot.
print.de.lorean

Print details of DeLorean object
pseudotimes.from.orderings

Convert best orderings into initialisations
test.mh

Test ordering Metropolis-Hastings sampler.