rvn_get_prd {RavenR} | R Documentation |
Check period input
Description
Checks a period argument either as a character or against an xts object.
Usage
rvn_get_prd(x = NULL, prd = NULL)
Arguments
x |
xts object |
prd |
period argument in format YYYY-MM-DD/YYYY-MM-DD as a character |
Details
The function may take some combination of an xts object, a character string or both.
If a character is provided, the consistency of the character string against the YYYY-MM-DD/YYYY-MM-DD format is checked. If an xts object is provided, the period for that xts object is returned. If both are provided to the function, both checks are made and the consistency of the character period against the xts object is performed. In any case, a period character string is returned.
Value
prd argument with warnings provided if needed
See Also
rvn_theme_RavenR
provides a theme for the RavenR package
Examples
data(rvn_hydrograph_data)
# check if string is a valid prd argument
rvn_get_prd(prd="2000-10-01/2002-09-30")
# rvn_get_prd(prd="2000-10-01/2002-24-30") # returns error
# get full valid prd argument for xts object
rvn_get_prd(rvn_hydrograph_data$hyd$Sub43_obs)
# check prd argument against xts object
rvn_get_prd(rvn_hydrograph_data$hyd$Sub43_obs, "2020-01-01/2020-02-01")
# rvn_get_prd(rvn_hydrograph_data$hyd$Sub43_obs, "2002-24-01/2020-02-01") # returns error
# rvn_get_prd(rvn_hydrograph_data$hyd$Sub43_obs, "20-24-01/2020-02-01") # returns error
[Package RavenR version 2.2.2 Index]