File: H5Rcreate.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 (28 lines) | stat: -rw-r--r-- 952 bytes parent folder | download | duplicates (2)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/H5R.R
\name{H5Rcreate}
\alias{H5Rcreate}
\title{Create a reference}
\usage{
H5Rcreate(h5loc, name, ref_type = "H5R_OBJECT", h5space = NULL)
}
\arguments{
\item{h5loc}{An \code{H5IdComponent} object representing the location to be pointed to
by the created reference.}

\item{name}{Character string giving the name of the object to be referenced,
relative to the location given by \code{h5loc}.}

\item{ref_type}{The type of reference to create.  Accepts either \code{H5R_OBJECT}
or \code{H5R_DATASET_REGION}.}

\item{h5space}{An object of class \code{H5IdComponent} representing a dataspace
with a selection set.  This argument is only used if creating a
reference to a dataset region, and will be ignored otherwise.}
}
\value{
An \linkS4class{H5Ref} object storing the reference.
}
\description{
Creates a reference to an object or dataset selection inside an HDF5 file.
}