zoo (version 1.8-9)

na.trim: Trim Leading/Trailing Missing Observations

Description

Generic function for removing leading and trailing NAs.

Usage

na.trim(object, …)
# S3 method for default
na.trim(object, sides = c("both", "left", "right"), 
	is.na = c("any", "all"), maxgap = Inf, …)

Arguments

object

an object.

sides

character specifying whether NAs are to be removed from both sides, just from the left side or just from the right side.

is.na

If "any" then a row will be regarded as NA if it has any NAs. If "all" then a row will be regarded as NA only if all elements in the row are NA. For one dimensional zoo objects this argument has no effect.

maxgap

maximum number of consecutive NAs to trim. Any longer gaps will be left unchanged.

…

further arguments passed to methods.

Value

An object in which leading and/or trailing NAs have been removed.

See Also

na.approx, na.contiguous, na.locf, na.omit, na.spline, stinterp, zoo

Examples

# NOT RUN {
# examples of na.trim
x <- zoo(c(1, 4, 6), c(2, 4, 6))
xx <- zoo(matrix(c(1, 4, 6, NA, 5, 7), 3), c(2, 4, 6))
na.trim(x)
na.trim(xx)

# using na.trim for alignment
# cal defines the legal dates
# all dates within the date range of x should be present
cal <- zoo(,c(1, 2, 3, 6, 7))
x <- zoo(c(12, 16), c(2, 6))
na.trim(merge(x, cal))

# }