prepare for CRAN

s-fleck · Aug 10, 2018 · 4a305dc · 4a305dc
1 parent dc32326
commit 4a305dc
Show file tree

Hide file tree

Showing 10 changed files with 15 additions and 23 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,11 +1,14 @@
 Type: Package
 Package: dint
-Title: Special Purpose Integer Dates 
+Title: A Toolkit for Year-Quarter and Year-Month Dates
 Version: 1.0.0
 Authors@R: person("Stefan", "Fleck", email = "stefan.b.fleck@gmail.com", role = c("aut", "cre"))
 Maintainer: Stefan Fleck <stefan.b.fleck@gmail.com>
 Description: 
-  A toolkit for working year-quarter and year-month dates.
+  S3 classes and methods to create and work with year-quarter and year-month 
+  vectors. Basic arithmetic operations (such as adding and subtracting) are
+  supported, as well as formatting and converting to and from standard R
+  Date types.
 License: MIT + file LICENSE
 URL: https://github.com/s-fleck/dint
 BugReports: https://github.com/s-fleck/dint/issues

diff --git a/R/date_y.R b/R/date_y.R
@@ -8,7 +8,6 @@
 #' @return `date_y` returns an object of type `date_y`
 #' @export
 #' @family simple dates
-#' @md
 #'
 #' @examples
 #' date_y(2013)
@@ -26,7 +25,6 @@ date_y <- function(y){
 #'   argument is of type `date_y` or not.
 #'
 #' @export
-#' @md
 #' @rdname date_y
 is_date_y <- function(x){
   inherits(x, "date_y")
@@ -37,7 +35,6 @@ is_date_y <- function(x){
 
 # as_data_y ---------------------------------------------------------------
 
-#' @md
 #' @return `as_date_m` attempts to coerce its argument to `date_y` type
 #' @export
 #' @rdname date_y

diff --git a/R/date_ym.R b/R/date_ym.R
@@ -13,7 +13,6 @@
 #' @export
 #' @family simple dates
 #' @seealso [format.date_ym()]
-#' @md
 #'
 #' @examples
 #' date_ym(2013, 12)
@@ -39,7 +38,6 @@ date_ym <- function(y, m) {
 #'   argument is of type `date_ym` or not.
 #'
 #' @export
-#' @md
 #' @rdname date_ym
 is_date_ym <- function(x){
   inherits(x, "date_ym")
@@ -48,7 +46,6 @@ is_date_ym <- function(x){
 
 
 
-#' @md
 #' @return `as_date_ym` attempts to coerce its argument to `date_ym` type
 #' @export
 #' @rdname date_ym
@@ -126,7 +123,6 @@ as.Date.date_ym <- function(x, ...){
 #'
 #' @return A character vector
 #'
-#' @md
 #' @export
 #' @examples
 #'
@@ -278,7 +274,6 @@ seq.date_ym <- function(x, y, ...){
 #'
 #' @inherit format.date_ym
 #'
-#' @md
 #' @family ym convenience functions
 #' @seealso [format.date_ym()]
 #' @export

diff --git a/R/date_yq.R b/R/date_yq.R
@@ -13,7 +13,6 @@
 #' @export
 #' @family simple dates
 #' @seealso [format.date_ym()]
-#' @md
 #'
 #' @examples
 #' date_yq(2013, 3)
@@ -39,7 +38,6 @@ date_yq <- function(y, q) {
 #'   argument is of type `date_yq` or not.
 #'
 #' @export
-#' @md
 #' @rdname date_yq
 is_date_yq <- function(x){
   inherits(x, "date_yq")
@@ -48,7 +46,6 @@ is_date_yq <- function(x){
 
 
 
-#' @md
 #' @return `as_date_yq` attempts to coerce its argument to `date_yq` type
 #' @export
 #' @rdname date_yq
@@ -129,7 +126,6 @@ as.Date.date_yq <- function(
 #'
 #' @return A character vector
 #'
-#' @md
 #' @export
 #' @examples
 #'
@@ -295,7 +291,6 @@ seq.date_yq <- function(x, y, ...){
 #'
 #' @inherit format.date_yq
 #'
-#' @md
 #' @family yq convenience functions
 #' @seealso [format.date_yq()]
 #' @export

diff --git a/R/first_day_of_month.R b/R/first_day_of_month.R
@@ -6,7 +6,6 @@
 #' @family ym convenience functions
 #' @seealso [first_day_of_month()]
 #' @export
-#' @md
 #'
 #' @examples
 #'
@@ -53,7 +52,6 @@ last_day_ym <- function(
 #' @return a [Date]
 #'
 #' @rdname day_of_month
-#' @md
 #' @export
 #' @examples
 #'

diff --git a/R/first_day_of_quarter.R b/R/first_day_of_quarter.R
@@ -6,7 +6,6 @@
 #' @family yq convenience functions
 #' @seealso [first_day_of_quarter()]
 #' @export
-#' @md
 #'
 #' @examples
 #'
@@ -47,7 +46,6 @@ last_day_yq <- function(x, q = NULL){
 #' @return a [Date]
 #'
 #' @rdname day_of_quarter
-#' @md
 #' @export
 #' @examples
 #'

diff --git a/R/first_day_of_year.R b/R/first_day_of_year.R
@@ -37,7 +37,6 @@ last_day_y <- function(x){
 #' @return a [Date]
 #'
 #' @rdname day_of_year
-#' @md
 #' @export
 #' @examples
 #' first_day_of_year("2016-06-04")

diff --git a/README.Rmd b/README.Rmd
@@ -16,7 +16,12 @@ knitr::opts_chunk$set(
 
 [![lifecycle](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
 
-A toolkit for working year-quarter and year-month dates
+A Toolkit for Year-Quarter and Year-Month Dates
+
+S3 classes and methods to create and work with year-quarter and year-month 
+vectors. Basic arithmetic operations (such as adding and subtracting) are
+supported, as well as formatting and converting to and from standard R
+Date types.
 
 ## Installation
 

diff --git a/README.md b/README.md
@@ -5,7 +5,9 @@ dint
 
 [![lifecycle](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
 
-A toolkit for working year-quarter and year-month dates
+A Toolkit for Year-Quarter and Year-Month Dates
+
+S3 classes and methods to create and work with year-quarter and year-month vectors. Basic arithmetic operations (such as adding and subtracting) are supported, as well as formatting and converting to and from standard R Date types.
 
 Installation
 ------------

diff --git a/vignettes/dint.Rmd b/vignettes/dint.Rmd
@@ -4,7 +4,7 @@ author: "Stefan Fleck"
 date: "`r Sys.Date()`"
 output: rmarkdown::html_vignette
 vignette: >
-  %\VignetteIndexEntry{Vignette Title}
+  %\VignetteIndexEntry{dint}
   %\VignetteEncoding{UTF-8}
   %\VignetteEngine{knitr::rmarkdown}
 editor_options: