add_cell_ids: Add cell IDs to a h5_list object

Description Usage Arguments Value

View source: R/filter_rna_h5.R

Description

Add cell IDs to a h5_list object

Usage

1
2
3
4
5
6
7
8
add_cell_ids(
  h5_list,
  target = "matrix",
  add_uuid = TRUE,
  replace_barcode = TRUE,
  retain_original_barcode = TRUE,
  add_name = TRUE
)

Arguments

h5_list

a list object generated by running rhdf5::h5dump() on a 10x HDF5 file.

target

the group name for the matrix within the h5_list to use. Default is "matrix", which is used by 10x.

add_uuid

a logical indicating whether or not to add a uuid generated by ids::uuid(). Default is TRUE.

replace_barcode

a logical indicating whether or not the new uuid should replace the barcodes slot. Default is TRUE.

retain_original_barcode

a logical indicating whether to retain the original barcodes if replace_barcode is TRUE. These will be moved to /matrix/original_barcode if TRUE. Default is TRUE.

add_name

a logical indicating whether to add a new cell name. These are adjective_adjective_animal names generated by ids::adjective_animal(). Default is TRUE.

Value

a modified h5_list object


AllenInstitute/BarMixer documentation built on Dec. 17, 2021, 8:42 a.m.