Merge pull request #71 from DavisVaughan/rc-0.1.0

RC 0.1.0

.Rbuildignore

@@ -10,3 +10,5 @@
 ^pkgdown$
 ^appveyor\.yml$
 ^\.github$
+^cran-comments\.md$
+^CRAN-RELEASE$

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: almanac
 Title: Tools for Working with Recurrence Rules
-Version: 0.0.0.9000
+Version: 0.1.0
 Authors@R: 
     c(person(given = "Davis",
              family = "Vaughan",
@@ -10,7 +10,7 @@ Authors@R:
              role = "cph"))
 Description: Provides tools for defining recurrence rules and
     recurrence bundles. Recurrence rules are a programmatic way to define
-    a recurring event, like "the first Monday of December". Multiple
+    a recurring event, like the first Monday of December. Multiple
     recurrence rules can be combined into larger recurrence bundles.
     Together, these provide a system for adjusting and generating
     sequences of dates while simultaneously skipping over dates in a

R/alma-in.R

@@ -1,4 +1,4 @@
-#' Is `x` in the event set?
+#' Check if dates are in an event set
 #'
 #' `alma_in()` checks if `x` is in the event set of dates defined by the
 #' rschedule.

R/rschedule.R

@@ -44,15 +44,6 @@
 #'
 #' # You have to register an `rschedule_events()` method first!
 #' try(alma_events(static))
-#'
-#' # For example, the below comment block could be run, and then
-#' # `alma_events()` would work, and would just return `x$events`.
-#'
-#' # rschedule_events.static_rschedule <- function(x) {
-#' #   x$events
-#' # }
-#' #
-#' # alma_events(static)
 new_rschedule <- function(..., class) {
   data <- list(...)
 

R/stepper.R

@@ -170,11 +170,14 @@ vec_ptype_full.almanac_stepper <- function(x, ...) {
 #' @param ... Used to pass along error message information.
 #'
 #' @return
-#'
 #' See the corresponding vctrs function for the exact return value.
 #'
 #' @name almanac-vctrs-compat
+#' @keywords internal
 #'
+#' @examples
+#' library(vctrs)
+#' vec_arith("+", as.Date("2019-01-04"), workdays(1))
 NULL
 
 # ------------------------------------------------------------------------------

README.Rmd

@@ -32,7 +32,11 @@ almanac provides tools for working with recurrence rules, the fundamental buildi
 
 ## Installation
 
-almanac is not yet on CRAN.
+Install the released version of almanac from CRAN with:
+
+``` r
+install.packages("almanac")
+```
 
 Install the development version from [GitHub](https://github.com/) with:
 
@@ -45,7 +49,7 @@ Mac and Windows users should not have any problems installing almanac. Linux use
 
 ## Recurrence Rules
 
-Constructing recurrence rules looks a little like this:
+Constructing recurrence rules looks like this:
 
 ```{r}
 # Thanksgiving = "The fourth Thursday in November"

README.md

@@ -23,7 +23,11 @@ weekends or holidays.
 
 ## Installation
 
-almanac is not yet on CRAN.
+Install the released version of almanac from CRAN with:
+
+``` r
+install.packages("almanac")
+```
 
 Install the development version from [GitHub](https://github.com/) with:
 
@@ -42,7 +46,7 @@ provided by Ubuntu versions before 19.04.
 
 ## Recurrence Rules
 
-Constructing recurrence rules looks a little like this:
+Constructing recurrence rules looks like this:
 
 ``` r
 # Thanksgiving = "The fourth Thursday in November"

cran-comments.md

@@ -0,0 +1,36 @@
+## Test environments
+* local R installation, R 3.6.0
+* ubuntu 16.04 (on travis-ci), R 3.6.0
+* win-builder (devel)
+
+## R CMD check results
+
+0 errors | 0 warnings | 1 note
+
+* This is a new release.
+
+## 0.1.0 Resubmission
+
+### Review 1 - 2020-05-21
+
+> Please only double quote publication titles in the description of the
+DESCRIPTION file. --> like the first Monday of December.
+
+I have fixed this in the DESCRIPTION file.
+
+> If there are references describing (the theoretical backgrounds of) the
+methods in your package, please add these in the description field of
+your DESCRIPTION file
+
+There are no references that I would like to include.
+
+> Examples/code lines in examples should never be commented out.
+Ideally find toy examples that can be regularly executed and checked.
+Lengthy examples (> 5 sec), can be wrapped in \donttest{}. If you don't
+want your code to be executed but still visible to the user, use \dontrun{}.
+
+I have removed the commented out code examples.
+
+## 0.1.0 Submission
+
+There are no references that I would like to include.