summary.scan {bioRad}R Documentation

Inspect a scan (scan)

Description

R base functions for inspecting a scan (scan) object.

Usage

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

is.scan(x)

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

Arguments

object

A scan object.

...

Additional arguments affecting the summary produced.

x

A scan object.

Details

A scan (or sweep) is made by the radar at a certain elevation angle. The resulting parameter data (param) are organized along radar range (bins) and azimuth (rays). A scan (scan) object is a list containing:

Value

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

For dim.scan(): number of parameters (param), bins and rays in a scan (scan).

See Also

Examples

# Load the example scan
scan <- example_scan

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

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

# Get dimensions
dim(scan)

# Get summary info for the parameters in the scan
scan$params

[Package bioRad version 0.5.2 Index]