Add function to get the number of operating days in the month.

[R/operatingdays.git] / R / getRemainingOpDays.R

diff --git a/R/getRemainingOpDays.R b/R/getRemainingOpDays.R
index 93256703184ed19984d0bafc48a465a248a33b22..a201071c26a182e6fb192e2f2f791fe67db0cd55 100644 (file)
--- a/R/getRemainingOpDays.R
+++ b/R/getRemainingOpDays.R
@@ -1,8 +1,13 @@
-# getRemainingOpDays
+#' getRemainingOpDays
 # This is a function that returns the remaining operating days in a month
 # It takes as arguments the country, state, date for which the request is made.
 # It returns a number
 # It currently only supports AU (Australia)
+#' @param country A country - use ISO format (currently only takes AU)
+#' @param state A state - use 2 or 3 letter abbreviation, in capitals
+#' @param date A date from which the remaining operating days in the month will be counted
+#' @return The number of remaining operating days in \code{state}, \code{country} as of \code{date}
+#' @examples getRemainingOpDays("AU","WA","2016-05-10")
 
 getRemainingOpDays <- function(country,state,date) {
   cutoff.time = "15:00"
@@ -16,6 +21,7 @@ getRemainingOpDays <- function(country,state,date) {
   state.public.holidays <- public.holidays[public.holidays$Applicable.To %in% c(state,"NAT"),]
   state.public.holidays$Date<-as.Date(state.public.holidays$Date,"%Y%m%d")
 
+  date <- as.Date(date)
   today <- Sys.Date()
   startdate <- as.Date(cut(date, "month"))
   enddate <- seq(startdate, by = "1 months", length.out = 2)[2]