bc_create_BarcodeObj: Create a BarcodeObj object from extracted barcodes data

bc_create_BarcodeObjR Documentation

Create a BarcodeObj object from extracted barcodes data

Description

Create a BarcodeObj object from extracted barcodes data

Usage

bc_create_BarcodeObj(x, sample_name = NULL, metadata = NULL, ordered = TRUE)

## S4 method for signature 'matrix'
bc_create_BarcodeObj(x, sample_name = NULL, metadata = NULL)

## S4 method for signature 'data.frame'
bc_create_BarcodeObj(x, sample_name = NULL, metadata = NULL)

Arguments

x

The barcodes data, it can be matrix, data.frame with each row as a barcode each column as a sample. The row names should be given as the barcode sequences, and the column names can be given as the sample names.

sample_name

A character vector, optional, specifying the sample name.

metadata

A data.frame, optional, specifying the metadata of each sample. The row names of the metadata should be the same as the sample names.

ordered

A logical value. If the value is true, the return barcodes (UMI-barcode tags) are sorted by the read counts.

Value

A BarcodeObj object.

Examples

data(bc_obj)
m = bc_2matrix(bc_obj)
bc_create_BarcodeObj(m)


wenjie1991/CellBarocde documentation built on Feb. 20, 2024, 2:12 p.m.