Documentation updated

R/adjust.date.R

@@ -38,13 +38,13 @@ NULL
 #' @rdname adjust.date
 #' @export
 #' @examples
-#' adjust.next("2013-01-01", "actual")
+#' adjust.next("2013-01-01", "Brazil/ANBIMA")
 adjust.next <- function(dates, cal) UseMethod("adjust.next")
 
 #' @rdname adjust.date
 #' @export
 #' @examples
-#' following("2013-01-01", "actual")
+#' following("2013-01-01", "Brazil/ANBIMA")
 following <- function(dates, cal) UseMethod("following")
 
 #' @export
@@ -79,7 +79,7 @@ following.Date <- adjust.next.Date
 #' @rdname adjust.date
 #' @export
 #' @examples
-#' modified.following("2016-01-31", "actual")
+#' modified.following("2016-01-31", "Brazil/ANBIMA")
 modified.following <- function(dates, cal) UseMethod("modified.following")
 
 #' @export
@@ -108,13 +108,13 @@ modified.following.Date <- function(dates,
 #' @rdname adjust.date
 #' @export
 #' @examples
-#' adjust.previous("2013-01-01", "actual")
+#' adjust.previous("2013-01-01", "Brazil/ANBIMA")
 adjust.previous <- function(dates, cal) UseMethod("adjust.previous")
 
 #' @rdname adjust.date
 #' @export
 #' @examples
-#' preceding("2013-01-01", "actual")
+#' preceding("2013-01-01", "Brazil/ANBIMA")
 preceding <- function(dates, cal) UseMethod("preceding")
 
 #' @export
@@ -149,7 +149,7 @@ preceding.Date <- adjust.previous.Date
 #' @rdname adjust.date
 #' @export
 #' @examples
-#' modified.preceding("2016-01-01", "actual")
+#' modified.preceding("2016-01-01", "Brazil/ANBIMA")
 modified.preceding <- function(dates, cal) UseMethod("modified.preceding")
 
 #' @export

R/bizdays.R

@@ -33,10 +33,10 @@
 #' \code{integer} objects representing the amount of business days.
 #'
 #' @examples
-#' bizdays("2013-01-02", "2013-01-31", "actual")
+#' bizdays("2013-01-02", "2013-01-31", "Brazil/ANBIMA")
 #'
 #' # Once you have a default calendar set, cal does not need to be provided
-#' bizdays.options$set(default.calendar = "actual")
+#' bizdays.options$set(default.calendar = "Brazil/ANBIMA")
 #' bizdays("2013-01-02", "2013-01-31")
 #'
 #' dates <- bizseq("2013-01-01", "2013-01-10")
@@ -142,7 +142,7 @@ bizdays.Date <- function(from, to,
 #' rule is applied.
 #'
 #' @examples
-#' bizdayse("2013-01-02", 3, "actual")
+#' bizdayse("2013-01-02", 3, "Brazil/ANBIMA")
 #' @export
 bizdayse <- function(dates, curd, cal) UseMethod("bizdayse")
 

R/bizdiff.R

@@ -18,7 +18,7 @@
 #'
 #' @examples
 #' dates <- c("2017-05-10", "2017-05-12", "2017-05-17")
-#' bizdiff(dates, "actual")
+#' bizdiff(dates, "Brazil/ANBIMA")
 #' @export
 bizdiff <- function(dates, cal) UseMethod("bizdiff")
 

R/bizseq.R

@@ -18,7 +18,7 @@
 #' objects with ISO formatted dates.
 #'
 #' @examples
-#' bizseq("2013-01-02", "2013-01-31", "actual")
+#' bizseq("2013-01-02", "2013-01-31", "Brazil/ANBIMA")
 #' @export
 bizseq <- function(from, to, cal) UseMethod("bizseq")
 

R/calendar.R

@@ -90,7 +90,7 @@
 #'   "2016-03-25", "2016-04-21", "2016-05-01", "2016-05-26", "2016-09-07",
 #'   "2016-10-12", "2016-11-02", "2016-11-15", "2016-12-25"
 #' ))
-#' cal <- create.calendar("Brazil/ANBIMA",
+#' cal <- create.calendar("ANBIMA",
 #'   holidays = holidays,
 #'   weekdays = c("saturday", "sunday")
 #' )

R/getbizdays.R

@@ -17,14 +17,14 @@
 #'
 #' @examples
 #' # for years
-#' getbizdays(2022:2024, "actual")
+#' getbizdays(2022:2024, "Brazil/ANBIMA")
 #'
 #' # for months
-#' getbizdays("2022-12", "actual")
+#' getbizdays("2022-12", "Brazil/ANBIMA")
 #'
 #' # using dates as references for months
 #' dts <- seq(as.Date("2022-01-01"), as.Date("2022-12-01"), by = "months")
-#' getbizdays(dts, "actual")
+#' getbizdays(dts, "Brazil/ANBIMA")
 #' @export
 getbizdays <- function(ref, cal = bizdays.options$get("default.calendar")) {
   cal <- check_calendar(cal)

R/getdate.R

@@ -41,10 +41,10 @@
 #' vectors.
 #'
 #' @examples
-#' getdate("10th wed", 2018, "actual")
-#' getdate("last bizday", 2010:2018, "actual")
+#' getdate("10th wed", 2018, "Brazil/ANBIMA")
+#' getdate("last bizday", 2010:2018, "Brazil/ANBIMA")
 #' dts <- seq(as.Date("2018-01-01"), as.Date("2018-12-01"), "month")
-#' getdate("first bizday", format(dts, "%Y-%m"), "actual")
+#' getdate("first bizday", format(dts, "%Y-%m"), "Brazil/ANBIMA")
 #' @export
 getdate <- function(expr, ref, cal = bizdays.options$get("default.calendar")) {
   cal <- check_calendar(cal)

R/is.bizday.R

@@ -18,10 +18,10 @@
 #' days.
 #'
 #' @examples
-#' is.bizday("2013-01-02", "actual")
+#' is.bizday("2013-01-02", "Brazil/ANBIMA")
 #'
 #' # Once you have a default calendar set, cal does not need to be provided
-#' bizdays.options$set(default.calendar = "actual")
+#' bizdays.options$set(default.calendar = "Brazil/ANBIMA")
 #'
 #' dates <- seq(as.Date("2013-01-01"), as.Date("2013-01-05"), by = "day")
 #' is.bizday(dates)

R/offset.R

@@ -31,10 +31,10 @@
 #' @name offset
 #'
 #' @examples
-#' offset("2013-01-02", 5, "actual")
+#' offset("2013-01-02", 5, "Brazil/ANBIMA")
 #'
 #' # Once you have a default calendar set, cal does not need to be provided
-#' bizdays.options$set(default.calendar = "actual")
+#' bizdays.options$set(default.calendar = "Brazil/ANBIMA")
 #'
 #' dates <- seq(as.Date("2013-01-01"), as.Date("2013-01-05"), by = "day")
 #' is.bizday(dates)