compYears: Function to determine complete water years

Description Usage Arguments Details Value

View source: R/compYears.R

Description

The function compYears looks through the data to determine which years are full of real values.

Usage

1
compYears(dates, data, year = c("water", "calendar", "climate"))

Arguments

dates

A vector of class(dates)='Date'.

data

Either a vector of the same length as dates or a two-dimensional array with one dimension equal to the length of dates.

year

A character string from c('water','calendar','climate') indicating which type of year should be evaluated. Water years run from October 01 through September 30. Calendar years run from January 01 through December 31. Climate years run from April 01 through March 31.

Details

Lorem ipsum...

Value

The function retruns a list of objects:

logiY

A logical data.frame of the same dimensions as data. TRUE indicates that the element is a member of a complete wate year.

numY

The number of complete years from each site.

sY

A numeric vector naming the nominal year of each element in dates.

year

The same as the input, for validation.


wfarmer-usgs/PUBAD documentation built on May 4, 2019, 5:21 a.m.