filter_vpts: Time and night/day selection in a time series of vertical...

Description Usage Arguments Details Value Examples

View source: R/filter_vpts.R

Description

Time and night/day selection in a time series of vertical profiles ('vpts')

Usage

1
filter_vpts(x, min, max, nearest, night, elev = -0.268, offset = 0)

Arguments

x

A vpts object.

min

Minimum datetime to be included. POSIXct value or character string convertable to POSIXct.

max

Maximum datetime to be included. POSIXct value or character string convertable to POSIXct.

nearest

If specified, min and max are ignored and the profile nearest to the specified datetime is returned that matches the day/night selection criteria. POSIXct value or character string convertable to POSIXct.

night

When TRUE select only night time profiles, when FALSE select only day time profiles, as classified by check_night.

elev

numeric. Sun elevation in degrees defining night time. May also be a numeric vector of length two, with first element giving sunset elevation, and second element sunrise elevation.

offset

numeric. Time duration in seconds by which to shift the start and end of night time. May also be a numeric vector of length two, with first element added to moment of sunset and second element added to moment of sunrise. See check_night for details.

Details

Returns profiles for which min <= timestamp profile < max. Selection for night and day occurs by check_night.

Value

An object of class 'vpts', or an object of class 'vp' if argument nearest is specified.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
# load example vertical profile time series:
data(example_vpts)
example_vpts

# select profiles later than 02-Sep-2016
filter_vpts(example_vpts, min = "2016-09-02")

# select the profile nearest to 2016-09-01 03:00 UTC:
filter_vpts(example_vpts, nearest = "2016-09-01 03:00")

# select profiles between than 1 and 3 UTC on 02-Sep-2016:
filter_vpts(example_vpts, min = "2016-09-02 01:00", max = "2016-09-02 03:00")

# select day time profiles (day time periods from sunrise to sunset)
filter_vpts(example_vpts, night=FALSE)

# select night time profiles, with nights starting starting and ending at civil twilight
# (when the sun is 6 degrees below the horizon):
filter_vpts(example_vpts, night=TRUE, elev = -6)

# select night time profiles from 3 hours after sunset to 2 hours before sunrise
filter_vpts(example_vpts, night=TRUE, offset=c(3,-2)*3600)

bioRad documentation built on July 1, 2020, 10:18 p.m.