h5createGroup: Create HDF5 group

Description Usage Arguments Details Value Author(s) References See Also Examples

View source: R/h5create.R

Description

Creates a group within an HDF5 file.

Usage

1
h5createGroup (file, group)

Arguments

file

The filename (character) of the file in which the dataset will be located. For advanced programmers it is possible to provide an object of class H5IdComponent representing a H5 location identifier (file or group). See H5Fcreate, H5Fopen, H5Gcreate, H5Gopen to create an object of this kind.

group

The name of the new group. The name can contain a hierarchy of groupnames, e.g. 'group1/group2/newgroup', but the function will fail if the top level group do not exists.

Details

Creates a new group within an HDF5 file.

Value

Returns TRUE is group was created successfully and FALSE otherwise.

Author(s)

Bernd Fischer

References

https://portal.hdfgroup.org/display/HDF5

See Also

h5createFile, h5createDataset, h5read, h5write, rhdf5

Examples

1
2
3
4
5
6
7
h5createFile("ex_createGroup.h5")

# create groups
h5createGroup("ex_createGroup.h5","foo")
h5createGroup("ex_createGroup.h5","foo/foobaa")

h5ls("ex_createGroup.h5")

Example output

[1] TRUE
[1] TRUE
[1] TRUE
  group   name     otype dclass dim
0     /    foo H5I_GROUP           
1  /foo foobaa H5I_GROUP           

rhdf5 documentation built on Nov. 8, 2020, 6:56 p.m.