SingleR.CreateObject: Wrapper function to create a SingleR object

Description Usage Arguments Value

View source: R/SingleR.Create.R

Description

Wrapper function to create a SingleR object

Usage

1
2
3
SingleR.CreateObject(sc.data, ref, clusters = NULL, species = "Human",
  citation = "-", technology = "-", variable.genes = "de",
  fine.tune = T, do.main.types = T, numCores = SingleR.numCores)

Arguments

sc.data

a matrix of single cell expression data

ref

a reference set object. This object must be a list containing: data - log2 normalized expression data; types - annotations for each of the samples; main_types - annotations for each of the samples, but less detailed; name - name for the reference set; sd.thres - a threshold for sd (used in 'sd' mode); de.genes - lists of lists of differentially expressed genes. Can be created using the CreateVariableGeneSet function. de.genes.main - lists of lists of differentially expressed genes. Can be created using the CreateVariableGeneSet function.

clusters

a numeric vector of cluster ids for each single cell. If NULL uses SingleR clustering.

species

The species of the sample ('Human' or 'Mouse').

citation

a citation for the project.

technology

The technology used for creating the single-cell data.

variable.genes

variable gene method to use - 'sd' or 'de'. Default is 'de'.

fine.tune

perform fine tuning. Default is TRUE. Fine-tuning may take long to run.

do.main.types

if TRUE runs a main cell type annotation using the main_types annotation.

numCores

Number of cores to use.

Value

a SingleR objects


dviraran/SingleR documentation built on April 21, 2020, 3:23 p.m.