is.pvolfile {bioRad}R Documentation

Check if a local file is a polar volume (pvol)

Description

Check whether a file is a polar volume in ODIM HDF5 format that can be read with package bioRad

Usage

is.pvolfile(file, filename = NULL)

Arguments

file

A string containing a file name.

filename

Deprecated argument, use file instead.

Details

The function checks whether a HDF5 file provided as input is a polar volume in ODIM HDF5 format. The function currently evaluates to FALSE for NEXRAD and IRIS RAW polar volume files.

Value

TRUE when file is a polar volume in readable format, otherwise FALSE

Examples

# locate example file:
pvolfile <- system.file("extdata", "volume.h5", package = "bioRad")

# check that the file is an ODIM HDF5 polar volume:
is.pvolfile(pvolfile) # > TRUE

[Package bioRad version 0.5.2 Index]