bioRad (version 0.5.1)

summary.pvol: Class pvol: a polar volume

Description

Class pvol for a polar volume, and its associated R base functions.

Usage

# S3 method for pvol
summary(object, ...)
is.pvol(x)

Arguments

object

Object of class pvol.

...

Additional arguments affecting the summary produced.

x

Object of class pvol.

Value

for is.pvol: TRUE if its argument is of class pvol

Details

An object of class pvol is a list containing:

radar

character string with the radar identifier

datetime

nominal time of the volume [UTC]

scans

a list with scan objects of class 'scan'

attributes

list with the volume's \what, \where and \how attributes

geo

geographic data, a list with:

lat

latitude of the radar [decimal degrees]

lon

longitude of the radar [decimal degrees]

height

height of the radar antenna [meters above sea level]

Examples

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

# print the local path of the volume file:
pvolfile

# load the file:
example_pvol <- read_pvolfile(pvolfile)

# print summary info for the loaded polar volume:
example_pvol

# verify that this is a pvol object:
is.pvol(example_pvol)

# print summary info for the scans in the polar volume:
example_pvol$scans

# copy the first scan to a new object 'scan':
scan <- example_pvol$scans[[1]]

# print summary info for the scan:
scan
is.pvol("this is not a polar volume but a string") # > FALSE
# }