write_h5_list: Write an h5_list, as created by rhdf5::h5dump(), to an .h5...

Description Usage Arguments Value

View source: R/write_rna_h5.R

Description

Write an h5_list, as created by rhdf5::h5dump(), to an .h5 file

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
write_h5_list(
  h5_list,
  h5_file,
  overwrite = FALSE,
  addon = FALSE,
  h5_handle = NULL,
  h5_target = "/",
  h5_attributes = NULL,
  library_ids = NULL
)

Arguments

h5_list

a list object, e.g. a list created by rhdf5::h5dump()

h5_file

a character object specifying the location of a .h5 file to write to.

overwrite

a logical value specifying whether or not to overwrite an existing .h5 file. Default is FALSE.

h5_handle

an existing h5_handle created by H5Fopen(). Used for recursion. The default (NULL) should usually be used.

h5_target

a base location within the HDF5 file to write to. Mainly used for recursion. The default ("/") should usually be used.

h5_attributes

a list of attributes to add to an .h5 file to try to imitate 10x Genomics outputs. If NULL (default), will be skipped. "tenx" uses in-built data from 'h5_attr_list()'.

library_ids

a character vector of library ids to add to attributes. Only used if h5_attributes != NULL. Default is NULL.

Value

Writes a file; no return to R.


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