nexrad_to_odim: Convert a NEXRAD polar volume file to an ODIM polar volume...

View source: R/nexrad_odim.R

nexrad_to_odimR Documentation

Convert a NEXRAD polar volume file to an ODIM polar volume file

Description

Convert a NEXRAD polar volume file to an ODIM polar volume file

Usage

nexrad_to_odim(
  pvolfile_nexrad,
  pvolfile_odim,
  verbose = FALSE,
  mount = dirname(pvolfile_nexrad),
  local_install
)

Arguments

pvolfile_nexrad

Polar volume input file in RSL format.

pvolfile_odim

Filename for the polar volume in ODIM HDF5 format to be generated.

verbose

Logical. When TRUE, Docker stdout is piped to the R console. Always TRUE on Windows.

mount

Character. Directory path of the mount point for the Docker container.

local_install

Character. Path to local vol2bird installation (e.g. your/vol2bird_install_directory/vol2bird/bin/vol2bird.sh).

Value

TRUE on success

Examples

## Not run: 
# download a NEXRAD file, save as KBGM_example
download.file(paste("https://noaa-nexrad-level2.s3.amazonaws.com/",
  "2019/10/01/KBGM/KBGM20191001_000542_V06",
  sep = ""
), "~/KBGM_example")

# convert to ODIM format
nexrad_to_odim("~/KBGM_example", "~/KBGM_example.h5")

# verify that we have generated a polar volume in ODIM HDF5 format
get_odim_object_type("~/KBGM_example.h5")

# clean up
file.remove("~/KBGM_example", "~/KBGM_example.h5")

## End(Not run)

bioRad documentation built on Aug. 31, 2022, 1:05 a.m.