File: list-groups-datasets.Rd

package info (click to toggle)
r-cran-hdf5r 1.3.8%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 10,192 kB
  • sloc: ansic: 76,883; sh: 82; python: 32; makefile: 13
file content (40 lines) | stat: -rw-r--r-- 1,301 bytes parent folder | download | duplicates (3)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/h5wrapper.R
\name{list-groups-datasets}
\alias{list-groups-datasets}
\alias{list.groups}
\alias{list.datasets}
\alias{list.objects}
\title{List Groups and Datasets in object}
\usage{
list.groups(object, path = "/", full.names = FALSE, recursive = TRUE,
  ...)

list.datasets(object, path = "/", full.names = FALSE,
  recursive = TRUE, ...)

list.objects(object, obj_type = c("H5I_GROUP", "H5I_DATASET",
  "H5I_DATATYPE"), path = "/", full.names = FALSE, recursive = TRUE,
  ...)
}
\arguments{
\item{object}{\code{CommonFG}; Object implementing the CommonFG Interface (e.g. \code{\link{H5File}}, \code{\link{H5Group}}).}

\item{path}{character; Path named to be used for iteration.}

\item{full.names}{character; Specify if absolute DataSet path names should be returned.}

\item{recursive}{logical; Specify if object should be traversed recursively.}

\item{...}{Additional Parameters passed to \code{$ls()}}

\item{obj_type}{character; Object type to be returned.}
}
\value{
\code{\link{character}}
}
\description{
List all Group (\code{\link{H5Group}}) and Dataset (\code{\link{H5D}}) 
names in the current object. This function is part of the \strong{h5} wrapper classes and
uses \code{$ls()} to retrieve group names.
}