add_cellhash_ids: Add cellhash sample information to altExperiment rowData

View source: R/add_cellhash_calls.R

add_cellhash_idsR Documentation

Add cellhash sample information to altExperiment rowData

Description

Add cellhash sample information to altExperiment rowData

Usage

add_cellhash_ids(
  sce,
  hashsample_table,
  altexp_id = "cellhash",
  remove_unlabeled = FALSE
)

Arguments

sce

SingleCellExperiment object.

hashsample_table

A data_frame of barcode_id and sample_id.

altexp_id

The name of the alternative experiment that contains the cellhash data. Default value: "cellhash"

remove_unlabeled

Remove altExp data for barcodes with no 'sample_id'in the 'hashsample_table' Default 'FALSE'.

Value

SingleCellExperiment with rowData for the altExp containing barcode and sample ids

Examples

## Not run: 
# add sample information for a cellhash table
add_cellhash_ids(
  sce = sce,
  hashsample_table = barcode_ids
)

## End(Not run)

AlexsLemonade/scpcaTools documentation built on July 12, 2024, 8:34 a.m.