File: h5listObjects.Rd

package info (click to toggle)
r-bioc-rhdf5 2.50.2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,584 kB
  • sloc: ansic: 8,521; cpp: 91; makefile: 11; python: 9; sh: 6
file content (44 lines) | stat: -rw-r--r-- 1,107 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Rhdf5.R
\name{h5listObjects}
\alias{h5listObjects}
\alias{h5listIdentifier}
\alias{h5validObjects}
\title{List all open HDF5 objects.}
\usage{
h5listIdentifier()

h5validObjects(native = FALSE)
}
\arguments{
\item{native}{An object of class \code{logical}. If TRUE, array-like objects
are treated as stored in HDF5 row-major rather than R column-major
orientation. Using \code{native = TRUE} increases HDF5 file portability
between programming languages. A file written with \code{native = TRUE}
should also be read with \code{native = TRUE}}
}
\value{
\code{h5validObjects} returns a list of \linkS4class{H5IdComponent}
objects. \code{h5listIdentifier} prints the valid identifiers on screen and
returns NULL.
}
\description{
A list of all valid HDF5 identifiers. H5 objects should be closed after usage
to release resources.
}
\examples{

h5File <- tempfile("ex_list_identifier.h5")

h5createFile(h5File)

# create groups
h5createGroup(h5File,"foo")

h5listIdentifier()
h5validObjects()

}
\author{
Bernd Fischer, Mike Smith
}