bioRad (version 0.5.1)

is.pvolfile: Check if a local file is a polar volume (pvol)

Description

Checker 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.

Value

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

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.

Examples

# NOT RUN {
# 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
# }