R: Return Pearson or deviance residuals of regularized models

get_residuals {sctransform}

R Documentation

Return Pearson or deviance residuals of regularized models

Description

Return Pearson or deviance residuals of regularized models

Usage

get_residuals(vst_out, umi, residual_type = "pearson",
  res_clip_range = c(-sqrt(ncol(umi)), sqrt(ncol(umi))),
  cell_attr = vst_out$cell_attr, bin_size = 256,
  show_progress = TRUE)

Arguments

`vst_out`	The output of a vst run
`umi`	The UMI count matrix that will be used
`residual_type`	What type of residuals to return; can be 'pearson' or 'deviance'; default is 'pearson'
`res_clip_range`	Numeric of length two specifying the min and max values the results will be clipped to; default is c(-sqrt(ncol(umi)), sqrt(ncol(umi)))
`cell_attr`	Data frame of cell meta data
`bin_size`	Number of genes to put in each bin (to show progress)
`show_progress`	Whether to print progress bar

Value

A matrix of residuals

Examples

## Not run: 
vst_out <- vst(pbmc)
pearson_res <- get_residuals(vst_out, pbmc)
deviance_res <- get_residuals(vst_out, pbmc, residual_type = 'deviance')

## End(Not run)

[Package sctransform version 0.2.0 Index]