h5List {hdf5r.Extra}

List the contents of an HDF5 group

Description

Function to list the contents of an HDF5 group.

Usage

h5List(x, ...)

## S3 method for class 'H5Group'
h5List(
  x,
  recursive = FALSE,
  full.names = FALSE,
  simplify = TRUE,
  detailed = FALSE,
  ...
)

## S3 method for class 'H5File'
h5List(
  x,
  name = "/",
  recursive = FALSE,
  full.names = FALSE,
  simplify = TRUE,
  detailed = FALSE,
  ...
)

## S3 method for class 'character'
h5List(
  x,
  name = "/",
  recursive = FALSE,
  full.names = FALSE,
  simplify = TRUE,
  detailed = FALSE,
  ...
)

Arguments

x

An H5File, H5Group or a path name of HDF5 file.

...

Additional parameters passed to $ls()

recursive

If TRUE, the contents of the whole group hierarchy will be listed.

full.names

Whether or not to return the absolute object path names.

simplify

Whether or not to only return the object names.

detailed

Whether or not to show the detailed information.

name

A link in file. Must refer to an H5Group. Default is "/".

Value

If simplify, will return a character vector specifying names of H5 links, otherwise will return a data.frame to show details.

See Also

H5Group$ls()

Examples

file <- system.file("extdata", "pbmc_small.h5ad", package = "hdf5r.Extra")

h5List(file)
h5List(file, "obs")
h5List(file, recursive = TRUE)
h5List(file, "obs", simplify = FALSE, recursive = TRUE)

h5g <- h5Open(file, "obs", mode = "r")
h5List(h5g)