File: h5attributes.Rd

package info (click to toggle)
r-cran-hdf5r 1.3.3%2Bdfsg-5
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 12,344 kB
  • sloc: ansic: 85,341; sh: 51; python: 32; makefile: 13
file content (40 lines) | stat: -rw-r--r-- 1,215 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/high_level_UI.R
\name{h5attributes}
\alias{h5attributes}
\alias{h5attr_names}
\alias{h5attr}
\alias{h5attr<-}
\title{Interface for HDF5 attributes}
\usage{
h5attributes(x)

h5attr_names(x)

h5attr(x, which)

h5attr(x, which) <- value
}
\arguments{
\item{x}{The object to which to attach the attribute to or retrieve it from. Can be one of \code{\link{H5Group}},  \code{\link{H5D}},
\code{\link{H5T}} or  \code{\link{H5File}}}

\item{which}{The name of the attribute to assign it to}

\item{value}{The value to assign to the attribute.}
}
\value{
For \code{h5attributes}, a named list with the content of the attributes read out. For \code{h5attr_names},
a vector of names of the attributes attached to the object \code{x}. For \code{h5attr}, the content of the attribute and
for \code{h5attr<-}, the assignment, the original object to which the attributes are attached (so that chaining is possible).
}
\description{
Interface for HDF5 attributes
}
\details{
Implements high-level functions that allows interactions with HDF5-attributes in a way very similar to regular R-object attributes
in R are handled.
}
\author{
Holger Hoefling
}