createURD: Create a new URD object

Description Usage Arguments Value

View source: R/urd-class.R

Description

Creates a new URD object. Provide expression data as UMI counts and (optionally) additional metdata. This function will perform basic filtering of the data (though the user may want to perform more advanced filtering before creating the URD object, using ds.meta.trim), will normalize and log2 transform the data, and will return an URD object with the original data in slot count.data, the normalized log-transformed data in slot logupx.data, the metadata in slot meta, and an initial grouping of the data drawn from the cell names, up to the first dash (-) or underscore (_) in slot group.ids.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
createURD(
  count.data,
  meta = NULL,
  min.cells = 3,
  min.genes = 500,
  min.counts = 10,
  gene.max.cut = 5000,
  max.genes.in.ram = 5000,
  verbose = T
)

Arguments

count.data

(Matrix or dgCMatrix) UMI expression data, with rows as genes and columns as cells

meta

(data.frame) Metadata, with rows as cells (row names should match column names of count.data)

min.cells

(Numeric) Minimum number of cells that must express a gene to retain it

min.genes

(Numeric) Minimum number of genes a cell must express to retain it

min.counts

(Numeric) Minimum number of UMIs detected for a gene across the entire data to retain it

gene.max.cut

(Numeric) Maximum number of UMIs observed for a gene in a single cell to retain it

max.genes.in.ram

(Numeric) Number of genes to normalize and log-transform at a time (to prevent running out of memory as matrices become non-sparse during the process)

Value

An URD object


farrellja/URD documentation built on June 17, 2020, 4:48 a.m.