h5set_extent {rhdf5} | R Documentation

## Set a new dataset extension

### Description

Set a new dataset extension to an existing dataset in an HDF5 file

### Usage

    h5set_extent(file, dataset, dims, native = FALSE)

### 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.
`dataset` | The name of the dataset in the HDF5 file, or an object of class `H5IdComponent` representing a H5 dataset identifier. See `H5Dcreate`, or `H5Dopen` to create an object of this kind.
`dims` | The dimensions of the array as they will appear in the file. Note, the dimensions will appear in inverted order when viewing the file with a C-programm (e.g. HDFView), because the fastest changing dimension in R is the first one, whereas the fastest changing dimension in C is the last one.
`native` | An object of class `logical`. If TRUE, array-like objects are treated as stored in HDF5 row-major rather than R column-major orientation. Using `native = TRUE` increases HDF5 file portability between programming languages. A file written with `native = TRUE` should also be read with `native = TRUE`

.

### Value

Returns 0 if the dimension of the dataset was changed successfully and a negative value otherwise.

### Author(s)

Bernd Fischer

### References

http://www.hdfgroup.org/HDF5

### See Also

rhdf5

### Examples

    library(rhdf5)
    tmpfile <- tempfile()
    h5createFile(file=tmpfile)
    h5createDataset(tmpfile, "A", c(10,12), c(20,24))
    h5ls(tmpfile, all=TRUE)[c("dim", "maxdim")]
    h5set_extent(tmpfile, "A", c(20,24))
    h5ls(tmpfile, all=TRUE)[c("dim", "maxdim")]

[Package rhdf5 version 2.24.0 Index]