Skip to content
Snippets Groups Projects
estBCVParams.Rd 773 B
Newer Older
Luke Zappia's avatar
Luke Zappia committed
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/estimate.R
\name{estBCVParams}
\alias{estBCVParams}
\title{Estimate Biological Coefficient of Variation parameters}
\usage{
estBCVParams(counts, params)
}
\arguments{
\item{counts}{counts matrix to estimate parameters from.}

\item{params}{splatParams object to store estimated values in.}
}
\value{
spaltParams object with estimated values.
}
\description{
Parameters are estimated using the \code{estimateDisp} function in the
\code{edgeR} package. Specifically the common dispersion and prior degrees
of freedom. See \code{\link{estimateDisp}} for details.
}
\examples{
Luke Zappia's avatar
Luke Zappia committed
\dontrun{
Luke Zappia's avatar
Luke Zappia committed
data("sc_example_counts")
Luke Zappia's avatar
Luke Zappia committed
params <- splatParams()
Luke Zappia's avatar
Luke Zappia committed
params <- estBCVParams(sc_example_counts, params)
params
}
Luke Zappia's avatar
Luke Zappia committed
}