doc

Author: Stefan Fleck

.gitignore

@@ -5,3 +5,4 @@
 man
 inst/doc
 docs
+_pkgdown.yml

NAMESPACE

@@ -17,6 +17,7 @@ S3method("^",date_yq)
 S3method(as.Date,date_y)
 S3method(as.Date,date_ym)
 S3method(as.Date,date_yq)
+S3method(as.POSIXct,date_xx)
 S3method(as.POSIXlt,date_xx)
 S3method(as_date_y,Date)
 S3method(as_date_y,default)
@@ -45,19 +46,15 @@ S3method(get_year,date_y)
 S3method(get_year,date_ym)
 S3method(get_year,date_yq)
 S3method(get_year,default)
-S3method(increment,date_ym)
-S3method(increment,date_yq)
 S3method(last_day_of_month,default)
 S3method(last_day_of_quarter,default)
 S3method(last_day_of_year,default)
 S3method(print,date_xx)
 S3method(seq,date_ym)
 S3method(seq,date_yq)
-export(as_date.date_xx)
 export(as_date_y)
 export(as_date_ym)
 export(as_date_yq)
-export(as_datetime.date_xx)
 export(date_y)
 export(date_ym)
 export(date_yq)
@@ -78,7 +75,6 @@ export(format_yq)
 export(get_month)
 export(get_quarter)
 export(get_year)
-export(increment)
 export(is_date_xx)
 export(is_date_y)
 export(is_date_ym)

R/date_xx.R

@@ -78,7 +78,7 @@ is_date_xx <- function(x){
 
 # print -------------------------------------------------------------------
 
-#' Title
+#' Print a date_xx Object
 #'
 #' @param x A [date_xx] object
 #' @param ... passed on to [format.date_yq()] or [format.date_ym()]

R/date_y.R

@@ -1,4 +1,4 @@
-#' A Simple Year Date Format
+#' A Simple S3-Class for Years
 #'
 #' A simple data type for storing years. A `date_y` object is just an
 #' integer with an additional class atribute.

R/date_ym.R

@@ -1,6 +1,6 @@
 # ctor --------------------------------------------------------------------
 
-#' A Simple Year-Month Date Format
+#' A Simple S3-Class for Year-Month Dates
 #'
 #' A simple data type for storing year-month dates in a human readable integer
 #' format, e.g.: December 2012 is stored as 201212. Supports simple arithmethics
@@ -117,7 +117,7 @@ as.Date.date_ym <- function(x, ...){
 
 # format ------------------------------------------------------------------
 
-#' Format a date_ym object
+#' Format a date_ym Object
 #'
 #' @param x a [date_ym] object
 #' @param format A scalar character, valid values are: `"iso"`, `"short"`, and
@@ -192,22 +192,7 @@ format_date_ym_shorter <- function(x){
 
 # algebra -----------------------------------------------------------------
 
-#' Date_ym arithmethic operations
-#'
-#' Currently only `+` and `-` are supported, all other basic arithmethic
-#' operations are disabled for date_ym objects.
-#'
-#' @param x a date_ym object
-#' @param y an integer
-#' @param ... passed on to methods
-#'
-#' @name date_ym_arithmetic
-#' @seealso [base::Arithmetic]
-
-
-
-
-#' @rdname date_ym_arithmetic
+#' @rdname date_xx_arithmetic
 #' @export
 `+.date_ym` <- function(x, y){
   increment(x, as.integer(y))
@@ -216,7 +201,7 @@ format_date_ym_shorter <- function(x){
 
 
 
-#' @rdname date_ym_arithmetic
+#' @rdname date_xx_arithmetic
 #' @export
 `-.date_ym` <- function(x, y){
   increment(x, as.integer(-y))
@@ -225,7 +210,7 @@ format_date_ym_shorter <- function(x){
 
 
 
-#' @rdname date_ym_arithmetic
+#' @rdname date_xx_arithmetic
 #' @export
 `*.date_ym` <- function(x, y){
   stop("Operation not supported")
@@ -234,7 +219,7 @@ format_date_ym_shorter <- function(x){
 
 
 
-#' @rdname date_ym_arithmetic
+#' @rdname date_xx_arithmetic
 #' @export
 `/.date_ym` <- function(x, y){
   stop("Operation not supported")
@@ -243,7 +228,7 @@ format_date_ym_shorter <- function(x){
 
 
 
-#' @rdname date_ym_arithmetic
+#' @rdname date_xx_arithmetic
 #' @export
 `^.date_ym` <- function(x, y){
   stop("Operation not supported")
@@ -252,7 +237,7 @@ format_date_ym_shorter <- function(x){
 
 
 
-#' @rdname date_ym_arithmetic
+#' @rdname date_xx_arithmetic
 #' @export
 `%%.date_ym` <- function(x, y){
   stop("Operation not supported")
@@ -261,7 +246,7 @@ format_date_ym_shorter <- function(x){
 
 
 
-#' @rdname date_ym_arithmetic
+#' @rdname date_xx_arithmetic
 #' @export
 `%/%.date_ym` <- function(x, y){
   stop("Operation not supported")
@@ -270,7 +255,7 @@ format_date_ym_shorter <- function(x){
 
 
 
-#' @rdname date_ym_arithmetic
+#' @rdname date_xx_arithmetic
 #' @export
 seq.date_ym <- function(x, y, ...){
   res <- seq.int(as.integer(x), as.integer(y))
@@ -282,7 +267,7 @@ seq.date_ym <- function(x, y, ...){
 
 # shortcuts ---------------------------------------------------------------
 
-#' Conveniently produce formatted Year-Month strings
+#' Direclty Create Formatted Year-Month Strings
 #'
 #' @param x,m Two integer (vectors). `m` is optional and the interpretation of
 #'   `x` will depend on whether `m` is supplied or not:

R/date_yq.R

@@ -1,6 +1,6 @@
 # ctor --------------------------------------------------------------------
 
-#' A Simple Year-Quarter Date Format
+#' A Simple S3-Class for Year-Quarter Dates
 #'
 #' A simple data type for storing year-quarter dates in a human readable integer
 #' format, e.g.: 3.Qurter of 2012 is stored as 20123. Supports simple arithmethics
@@ -120,7 +120,7 @@ as.Date.date_yq <- function(
 
 # format ------------------------------------------------------------------
 
-#' Format a date_yq object
+#' Format a date_yq Object
 #'
 #' @param x a [date_yq] object
 #' @param format A scalar character, valid values are: `"iso"`, `"short"`, and
@@ -198,17 +198,16 @@ format_date_yq_shorter <- function(x){
 
 # algebra -----------------------------------------------------------------
 
-#' Date_yq arithmethic operations
+#' Date Arithmetic Operations
 #'
 #' Currently only `+` and `-` are supported, all other basic arithmethic
 #' operations are disabled for date_yq objects.
 #'
-#' @param x a date_yq object
+#' @param x a [`date_yq`] or [`date_ym`] object
 #' @param y an integer
 #' @param ... currently ingored.
 #'
-#' @md
-#' @rdname date_yq_arithmetic
+#' @rdname date_xx_arithmetic
 #' @aliases date_yq_arithmetic
 #' @seealso [base::Arithmetic]
 #' @export
@@ -285,7 +284,7 @@ seq.date_yq <- function(x, y, ...){
 
 # shortcuts ---------------------------------------------------------------
 
-#' Conveniently produce formatted Year-Quarter strings
+#' Direclty Create Formatted Year-Quarter Strings
 #'
 #' @param x,q Two integer (vectors). `q` is optional and the interpretation of
 #'   `x` will depend on whether `q` is supplied or not:

R/first_day_of_month.R

@@ -1,6 +1,4 @@
-
-
-#' Conveniently get first/last day of month from numbers
+#' Get First or Last Day of Month From Year and Month
 #'
 #' @inheritParams format_ym
 #' @inherit first_day_of_month
@@ -95,9 +93,7 @@ last_day_of_month.default <- function(x){
 
   ifelse_simple(
     month < 12,
-    make_date(get_year(x) , month + 1, 1) - 1,
+    make_date(get_year(x), month + 1, 1) - 1,
     make_date(get_year(x), 12, 31)
   )
 }
-
-

R/first_day_of_quarter.R

@@ -1,6 +1,4 @@
-
-
-#' Conveniently get first/last day of quarter from numbers
+#' Get First or Last Day of Quarter From Year and Quarter
 #'
 #' @inheritParams format_yq
 #' @inherit first_day_of_quarter

R/first_day_of_year.R

@@ -1,28 +1,28 @@
-
-
-#' Conveniently get first/last day of year from numbers
+#' Get First or Last Day of a Year
+#'
+#' `first_day_y()` is equivalent with `first_day_of_year()` and only included
+#' for summetry with [first_day_yq()] and [first_day_ym()].
+#'
 #'
 #' @inheritParams format_ym
 #' @inherit first_day_of_year
 #'
 #' @family ym convenience functions
 #' @seealso [first_day_of_year()]
 #' @export
-#' @md
+#' @rdname day_of_year
 #'
 #' @examples
-#'
 #' first_day_y(2016)
 #' first_day_y(2016)
-#'
 first_day_y <- function(x){
   first_day_of_year(date_y(x))
 }
 
 
 
 
-#' @rdname first_day_y
+#' @rdname day_of_year
 #' @export
 last_day_y <- function(x){
   last_day_of_year(date_y(x))
@@ -40,10 +40,8 @@ last_day_y <- function(x){
 #' @md
 #' @export
 #' @examples
-#'
 #' first_day_of_year("2016-06-04")
 #' last_day_of_year("2016-06-04")
-#'
 first_day_of_year <- function(x){
   UseMethod("first_day_of_year")
 }

R/get_year.R

@@ -65,7 +65,7 @@ get_year.default <- function(x){
 
 
 
-#' Get Components of a date_xx (lubridate compat)
+#' Get Year, Quarter or Month (lubridate Compatibility)
 #'
 #' See [lubridate::year()] and [lubridate::month()]
 #'