Skip to contents

A wrapper to rhdf5::h5ls() that works on H5File objects

h5ls.Rd

Like rhdf5::h5ls(), but works on an H5File object.

Usage

h5ls(file, recursive=TRUE, all=FALSE, datasetinfo=TRUE,
           index_type=h5default("H5_INDEX"), order=h5default("H5_ITER"),
           s3=FALSE, s3credentials=NULL, native=FALSE)

Arguments

file, recursive, all, datasetinfo, index_type, order, s3, s3credentials, native

See ?rhdf5::h5ls in the rhdf5 package for a description of these arguments.

Note that the only difference with rhdf5::h5ls() is that, with h5mread::h5ls(), file can be an H5File object.

Value

See ?rhdf5::h5ls in the rhdf5 package.

See also

Examples

test_h5 <- system.file("extdata", "test.h5", package="h5mread")
h5ls(test_h5)
#> Warning: An open HDF5 file handle exists. If the file has changed on disk meanwhile, the function may not work properly. Run 'h5closeAll()' to close all open HDF5 object handles.
#>           group         name       otype  dclass          dim
#> 0             / .m2_dimnames   H5I_GROUP                     
#> 1 /.m2_dimnames            1 H5I_DATASET  STRING         4000
#> 2 /.m2_dimnames            2 H5I_DATASET  STRING           90
#> 3             /           a3 H5I_DATASET INTEGER 180 x 75 x 4
#> 4             /           m1 H5I_DATASET INTEGER       12 x 5
#> 5             /           m2 H5I_DATASET   FLOAT    4000 x 90
#> 6             /           m4 H5I_DATASET INTEGER    28 x 4000
#> 7             /       rwords H5I_DATASET  STRING        30000

h5file <- H5File(test_h5)
h5ls(h5file)
#>           group         name       otype  dclass          dim
#> 0             / .m2_dimnames   H5I_GROUP                     
#> 1 /.m2_dimnames            1 H5I_DATASET  STRING         4000
#> 2 /.m2_dimnames            2 H5I_DATASET  STRING           90
#> 3             /           a3 H5I_DATASET INTEGER 180 x 75 x 4
#> 4             /           m1 H5I_DATASET INTEGER       12 x 5
#> 5             /           m2 H5I_DATASET   FLOAT    4000 x 90
#> 6             /           m4 H5I_DATASET INTEGER    28 x 4000
#> 7             /       rwords H5I_DATASET  STRING        30000

## See '?H5File' for more examples.