summary.vpts {bioRad}R Documentation

Inspect a time series of vertical profiles (vpts)

Description

R base functions for inspecting a time series of vertical profiles (vp) 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:

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

See Also

Examples

# Load the example time series of vertical profiles
vpts <- example_vpts

# Verify that it is an object of class vpts
is.vpts(vpts)

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

# Get dimensions
dim(vpts)

[Package bioRad version 0.5.2 Index]