Skip to content
Snippets Groups Projects
simpleEstimate.Rd 1.19 KiB
Newer Older
  • Learn to ignore specific revisions
  • % Generated by roxygen2: do not edit by hand
    % Please edit documentation in R/simple-estimate.R
    \name{simpleEstimate}
    \alias{simpleEstimate}
    \alias{simpleEstimate.SCESet}
    \alias{simpleEstimate.matrix}
    \title{Estimate simple simulation parameters}
    \usage{
    simpleEstimate(counts, params = newSimpleParams())
    
    \method{simpleEstimate}{SCESet}(counts, params = newSimpleParams())
    
    \method{simpleEstimate}{matrix}(counts, params = newSimpleParams())
    }
    \arguments{
    \item{counts}{either a counts matrix or an SCESet object containing count
    data to estimate parameters from.}
    
    \item{params}{SimpleParams object to store estimated values in.}
    }
    \value{
    SimpleParams object containing the estimated parameters.
    }
    \description{
    Estimate simulation parameters for the simple simulation from a real dataset.
    }
    \details{
    The \code{nGenes} and \code{nCells} parameters are taken from the size of the
    input data. The mean parameters are estimated by fitting a gamma distribution
    to the library size normalised mean expression level using
    \code{\link[fitdistrplus]{fitdist}}. See \code{\link{SimpleParams}} for more
    details on the parameters.
    }
    \examples{
    data("sc_example_counts")
    params <- simpleEstimate(sc_example_counts)
    params
    }