CreateSinglerObject: 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
4
5
6
CreateSinglerObject(counts, annot = NULL, project.name, min.genes = 0,
  technology = "10X", species = "Human", citation = "",
  ref.list = list(), normalize.gene.length = F,
  variable.genes = "de", fine.tune = T, do.signatures = F,
  clusters = NULL, do.main.types = T, reduce.file.size = T,
  temp.dir = NULL, numCores = SingleR.numCores)

Arguments

counts

a tab delimited text file containing the counts matrix, a 10X directory name or a matrix with the counts.

annot

a tab delimited text file or a data.frame. Rownames correspond to column names in the counts data

project.name

the project name

min.genes

Include cells where at least this many genes are detected (number non-zero genes).

technology

The technology used for creating the single-cell data.

species

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

citation

a citation for the project.

ref.list

a list of reference objects. If NULL uses the predefined reference objects - Mouse: ImmGen and Mouse.RNAseq, Human: HPCA and Blueprint+Encode.

normalize.gene.length

if a full-length method set to TRUE, if a 3' method set to FALSE.

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.signatures

create signatures data

clusters

input cluster id for each of the cells with at least min.genes, if NULL uses SingleR clusterings.

do.main.types

run the SingleR pipeline for main cell types (cell types grouped together) as well.

reduce.file.size

remove less used SingleR fields that increase the object size.

temp.dir

used by the SingleR webtool.

numCores

Number of cores to use.

Value

a SingleR object


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