H5Pset_fapl_ros3: Set the read-only S3 virtual file driver

In grimbough/rhdf5: R Interface to HDF5

Set the read-only S3 virtual file driver

Description

The read-only S3 virtual file driver can be used to read files hosted remotely on Amazon's S3 storage.

Usage

H5Pset_fapl_ros3(h5plist, s3credentials = NULL)

Arguments

h5plist	H5IdComponent object representing a file access property list.
s3credentials	Either NULL or a list of length 3 specifying the AWS access credentials (see details).

Details

To access files in a private Amazon S3 bucket you will need to provide three additional details: The AWS region where the files are hosted, your AWS access key ID, and your AWS secret access key. More information on how to obtain AWS access keys can be found at https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. These are provided as a list to the s3credentials argument. If you are accessing public data this argument should be NULL.

Examples

## this doesn't work on the Bioconductor Mac build machine
## Not run: 
pid <- H5Pcreate("H5P_FILE_ACCESS")
H5Pset_fapl_ros3( pid )
H5Pclose(pid)

## End(Not run)

grimbough/rhdf5 documentation built on Sept. 14, 2024, 8:41 a.m.