summary.vpts: Inspect a time series of vertical profiles ('vpts')

View source: R/vpts.R

summary.vptsR Documentation

Inspect a time series of vertical profiles (vpts)

Description

R base functions for inspecting a time series of vertical profiles (vpts) object.

Usage

## S3 method for class 'vpts'
summary(object, ...)

is.vpts(x)

## S3 method for class 'vpts'
dim(x)

Arguments

object

A vpts object.

...

Additional arguments affecting the summary produced.

x

A vpts object.

Details

A time series of vertical profiles contains time-ordered vertical profiles (vp) of a single radar. This time series can be regular (vp are equally spaced in time) or irregular (time steps between vp are of unequal length), indicated in the field regular. Irregular time series can be projected onto a regular time grid with regularize_vpts(). A time series of vertical profile (vp) object is a list containing:

  • radar: Radar identifier.

  • datetime: Nominal times of the profiles (named dates in bioRad < 0.4.0) in UTC.

  • height: Lowest height of the height bins in the profiles in m above sea level.

  • daterange: Minimum and maximum nominal time of the profiles in UTC.

  • timesteps: Time differences between the profiles. Element i gives the difference between profile i and i+1.

  • data: A list of quantities, each containing a datetime by height matrix with the values. Use get_quantity() to access these and see summary.vp() for a description of available quantities.

  • attributes: List of the vertical profile's what, where, and how attributes, copied from the first profile.

  • regular: Logical indicating whether the time series is regular or not.

Value

For is.vpts(): TRUE for an object of class vpts, otherwise FALSE.

For dim.vpts(): number of datetimes, heights and quantities in a time series of vertical profiles (vpts).

Conventions

  • NA: Maps to nodata in the ODIM convention: value to denote areas void of data (never radiated).

  • NaN: Maps to undetect in the ODIM convention: denote areas below the measurement detection threshold (radiated but nothing detected). The value is also used when there are too few datapoints to calculate a quantity.

  • 0: Maps to 0 in the ODIM convention: denote areas where the quantity has a measured value of zero (radiated and value zero detected or inferred).

See Also

  • bind_into_vpts()

  • read_vpts()

  • filter_vpts()

  • regularize_vpts()

  • example_vpts

  • get_quantity()

  • plot.vp()

  • as.data.frame.vpts()

  • [vpts()

Examples

# Check if an object is of class vpts
is.vpts(example_vpts)

# Get summary info
example_vpts # Same as summary(example_vpts) or print(example_vpts)

# Get dimensions
dim(example_vpts)

bioRad documentation built on May 10, 2022, 1:07 a.m.