Package index • bioRad

Reading radar data

Functions to read polar volume (pvol) data.

download_pvolfiles(): Download polar volume (pvol) files from the NEXRAD archive

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

get_iris_raw_task(): Check the task type of an IRIS RAW file

get_odim_object_type(): Check the data type of an ODIM HDF5 file

nexrad_to_odim(): Convert a NEXRAD polar volume file to an ODIM polar volume file

read_pvolfile(): Read a polar volume (pvol) from file

write_pvolfile(): Write a polar volume (pvol) object to ODIM HDF5 file

summary(<pvol>) is.pvol() dim(<pvol>): Inspect a polar volume (pvol)

Inspecting radar scans

Functions to inspect and plot a polar scan (scan) from a polar volume (pvol).

get_elevation_angles(): Get elevation angles of a polar volume (pvol), scan (scan) or parameter (param)

get_scan(): Get a scan (scan) from a polar volume (pvol)

summary(<scan>) is.scan() dim(<scan>): Inspect a scan (scan)

example_scan: Scan (scan) example

plot(<scan>): Plot a scan (scan) in polar coordinates

get_param(): Get a parameter (param) from a scan (scan)

summary(<param>) is.param(): Inspect a parameter (param)

Manipulating radar scans

Functions to manipulate radar images (scan, param, ppi) and to identify precipitation.

integrate_to_ppi(): Calculate a plan position indicator (ppi) of vertically integrated density adjusted for range effects

calculate_param(): Calculate a new scan parameter

apply_mistnet(): Apply MistNet segmentation to a polar volume

select.scan(): Tidyverse methods for bioRad objects

Math(<scan>) Math(<pvol>) Ops(<param>) Ops(<scan>) Ops(<pvol>): Mathematical and arithmetic operations on param's, scan's and pvol's

Plotting radar scans

Functions to plot a polar volume (pvol), scan (scan) or parameter (param) on a grid or basemap as a plan position indicator (ppi).

project_as_ppi(): Project a scan (scan) or parameter (param) to a plan position indicator (ppi)

integrate_to_ppi(): Calculate a plan position indicator (ppi) of vertically integrated density adjusted for range effects

scan_to_raster(): convert a polar scan into a raster

scan_to_spatial(): convert a polar scan into a spatial object.

summary(<ppi>) is.ppi() dim(<ppi>): Inspect a plan position indicator (ppi)

plot(<ppi>): Plot a plan position indicator (ppi)

map(): Map a plan position indicator (ppi) on a map

check_docker() update_docker() vol2bird_version() download_basemap(): Deprecated bioRad functions and data

composite_ppi(): Create a composite of multiple plan position indicators (ppi)

`[`(<ppi>): Subset a plan position indicator (ppi)

Creating vertical profiles of biological targets

Functions to process weather radar data (pvol) into vertical profiles (vp) of biological targets.

calculate_vp(): Calculate a vertical profile (vp) from a polar volume (pvol) file

nexrad_to_odim(): Convert a NEXRAD polar volume file to an ODIM polar volume file

Reading vertical profile data

Functions to download, read, inspect and plot vertical profile (vp) data.

download_vpfiles() superseded: Download vertical profile (vp) files from the ENRAM data repository

select_vpfiles(): Select vertical profile (vp) files from computer

is.vpfile(): Check if a file is a vertical profile (vp)

read_vpfiles(): Read a vertical profile (vp) or a list of vertical profiles (vp) from files

read_cajun(): Read a vertical profile (vp) from UMASS Cajun text file

summary(<vp>) is.vp() dim(<vp>): Inspect a vertical profile (vp)

example_vp: Vertical profile (vp) example

plot(<vp>): Plot a vertical profile (vp)

as.data.frame(<vp>) as.data.frame(<vpts>): Convert a vertical profile (vp) or time series of vertical profiles (vpts) to a data frame

list_vpts_aloft() superseded: List aloft urls for time series of vertical profiles (vpts) of radar stations

Manipulating vertical profile data

Functions to combine vertical profiles (vp) into time series (vpts) and to post-process, read, inspect and plot these.

c(<vp>): Concatenate vertical profiles (vp) into a list of vertical profiles

bind_into_vpts(): Bind vertical profiles (vp) into time series (vpts)

read_vpts(): Read time series of vertical profiles (vpts) from file(s)

filter_vpts(): Filter a time series of vertical profiles ('vpts').

filter_precip(): Posthoc precipitation filter

clean_mixture(): Partition mixtures of animals using assumptions on airspeeds.

summary(<vpts>) print(<vpts>) is.vpts() dim(<vpts>) `[`(<vpts>): Inspect a time series of vertical profiles (vpts)

example_vpts: Time series of vertical profiles (vpts) example

plot(<vpts>): Plot a time series of vertical profiles (vpts)

regularize_vpts(): Regularize a time series of vertical profiles (vpts) on a regular time grid

as.data.frame(<vp>) as.data.frame(<vpts>): Convert a vertical profile (vp) or time series of vertical profiles (vpts) to a data frame

as.vp(): Convert a dataframe into a vp object

as.vpts(): Convert a dataframe into a vpts object

get_quantity(): Get a quantity from a vertical profile (vp) or time series of vertical profiles (vpts)

Integrating vertical profiles

Functions to calculate e.g. the migration traffic rate (MTR) by vertically integrating profiles (vp or vpts) into an integrated profile (vpi).

integrate_profile(): Vertically integrate profiles (vp or vpts) into an integrated profile (vpi)

plot(<vpi>): Plot an integrated profile (vpi)

summary(<vpi>) is.vpi(): Inspect an integrated profile (vpi)

Accessing vertical profile metadata

Functions to access metadata of vertical profiles (vp), time series (vpts) or integrated profiles (vpi).

rcs(): Get radar cross section

`rcs<-`(): Set radar cross section

sd_vvp_threshold(): Get threshold of the radial velocity standard deviation

`sd_vvp_threshold<-`(): Set threshold of the radial velocity standard deviation

check_night(): Check if it is night at a given time and place

doy() noy(): Look up day of year (doy) or night of year (noy)

attribute_table(): Extract a volume coverage pattern table with all attributes

Radar beam geometry

Functions relating the radar beam shape to range, distance and height.

beam_height(): Calculate radar beam height

beam_width(): Calculate radar beam width

beam_range(): Calculate radar beam range

beam_distance(): Calculate radar beam distance

beam_profile(): Calculate vertical radiation profile

beam_profile_overlap(): Calculate overlap between a vertical profile ('vp') and the vertical radiation profile emitted by the radar

Other functions

Other useful functions.

dbz_to_eta(): Convert reflectivity factor (dBZ) to reflectivity (eta)

eta_to_dbz(): Convert reflectivity (eta) to reflectivity factor (dBZ)

nyquist_velocity(): Calculate Nyquist velocity for a given pulse repetition frequency (PRF)

sunrise() sunset(): Calculate sunrise or sunset for a time and place

convert_legacy(): Convert legacy bioRad objects