read_stdout: Read a time series of vertical profiles ('vpts') from file

View source: R/read_stdout.R

read_stdoutR Documentation

Read a time series of vertical profiles (vpts) from file

Description

Read a time series of vertical profiles (vpts) from file

Usage

read_stdout(file, radar, lat, lon, height, wavelength = "C", sep = "")

Arguments

file

A text file containing the standard output (stdout) generated by vol2bird (or the package function calculate_vp).

radar

A string containing a radar identifier.

lat

numeric. Latitude of the radar in decimal degrees.

lon

numeric. Longitude of the radar in decimal degrees.

height

numeric. Height above sea level of the radar antenna in meters.

wavelength

Radar wavelength in cm, or one of 'C' or 'S' for C-band and S-band radar, respectively, in which case C-band wavelength is assumed to be 5.3 cm and S-band wavelength 10.6 cm

sep

the field separator character, see utils::read.table

Value

An object inheriting from class vpts, see vpts() for details.

Examples

# locate example file:
stdout_file <- system.file("extdata", "example_vpts.txt", package = "bioRad")
# load time series:
ts <- read_stdout(stdout_file, radar = "KBGM", wavelength = "S")
ts

adokter/birdRad documentation built on Nov. 5, 2024, 10:27 p.m.