diff --git a/.Rbuildignore b/.Rbuildignore index 626c19f1..b31f52c6 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -10,3 +10,5 @@ ^docs$ ^pkgdown$ ^vignettes/articles$ +^cran-comments\.md$ +^CRAN-RELEASE$ diff --git a/DESCRIPTION b/DESCRIPTION index c55fc43e..e2e32ee2 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: clock Title: Date-Time Types and Tools -Version: 0.0.0.9000 +Version: 0.1.0 Authors@R: c(person(given = "Davis", family = "Vaughan", @@ -12,13 +12,12 @@ Authors@R: comment = "Author of the included date library"), person(given = "RStudio", role = c("cph", "fnd"))) -Description: Provides a comprehensive library for date-time - manipulations using a new family of orthogonal date-time classes - (durations, time points, zoned-times, and calendars) that partition - responsibilities so that the complexities of time zones are only - considered when they are really needed. Capabilities include: - date-time parsing, formatting, arithmetic, extraction and updating of - components, and rounding. +Description: Provides a comprehensive library for date-time manipulations + using a new family of orthogonal date-time classes (durations, time + points, zoned-times, and calendars) that partition responsibilities so + that the complexities of time zones are only considered when they are + really needed. Capabilities include: date-time parsing, formatting, + arithmetic, extraction and updating of components, and rounding. License: MIT + file LICENSE URL: https://github.com/r-lib/clock BugReports: https://github.com/r-lib/clock/issues diff --git a/R/posixt.R b/R/posixt.R index 0f7f8cad..e0d658a7 100644 --- a/R/posixt.R +++ b/R/posixt.R @@ -444,7 +444,7 @@ arith_duration_and_posixt <- function(op, x, y, ...) { #' yourself. For example, you could convert the previous example to a #' naive-time instead of a sys-time manually with [as_naive_time()], add #' 1 second giving `"2020-03-08 02:00:00"`, then convert back to a -#' POSIXct/POSIXlt, dealing with the nonexistent time that get's created by +#' POSIXct/POSIXlt, dealing with the nonexistent time that gets created by #' using the `nonexistent` argument of `as.POSIXct()`. #' #' @inheritParams add_years diff --git a/README.Rmd b/README.Rmd index 97362812..b843dc86 100644 --- a/README.Rmd +++ b/README.Rmd @@ -15,7 +15,7 @@ knitr::opts_chunk$set( ) ``` -# clock +# clock [![Codecov test coverage](https://codecov.io/gh/r-lib/clock/branch/master/graph/badge.svg)](https://codecov.io/gh/r-lib/clock?branch=master) @@ -44,7 +44,13 @@ There are four key classes in clock, inspired by the design of the C++ date and ## Installation -You can install the development version of clock with: +Install the released version from [CRAN](https://CRAN.R-project.org) with: + +``` r +install.packages("clock") +``` + +Install the development version from [GitHub](https://github.com/) with: ``` r # install.packages("remotes") diff --git a/README.md b/README.md index 7b4f3038..d792e351 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# clock +# clock @@ -69,7 +69,14 @@ you get a complete date time library. ## Installation -You can install the development version of clock with: +Install the released version from [CRAN](https://CRAN.R-project.org) +with: + +``` r +install.packages("clock") +``` + +Install the development version from [GitHub](https://github.com/) with: ``` r # install.packages("remotes") diff --git a/cran-comments.md b/cran-comments.md new file mode 100644 index 00000000..68456c7b --- /dev/null +++ b/cran-comments.md @@ -0,0 +1,14 @@ +## R CMD check results + +0 errors | 0 warnings | 2 notes + +* This is a new release. + +* checking installed package size ... NOTE + installed size is 7.8Mb + sub-directories of 1Mb or more: + libs 5.6Mb + +## 0.1.0 Submission + +This is the first release of clock. There are no references that I would like to include with the package. The installed size of clock may be large on some platforms due to the large amount of templated C++ code included with the package. diff --git a/man/clock-package.Rd b/man/clock-package.Rd index d5372c33..1d0c03e5 100644 --- a/man/clock-package.Rd +++ b/man/clock-package.Rd @@ -8,13 +8,12 @@ \description{ \if{html}{\figure{logo.png}{options: align='right' alt='logo' width='120'}} -Provides a comprehensive library for date-time - manipulations using a new family of orthogonal date-time classes - (durations, time points, zoned-times, and calendars) that partition - responsibilities so that the complexities of time zones are only - considered when they are really needed. Capabilities include: - date-time parsing, formatting, arithmetic, extraction and updating of - components, and rounding. +Provides a comprehensive library for date-time manipulations + using a new family of orthogonal date-time classes (durations, time + points, zoned-times, and calendars) that partition responsibilities so + that the complexities of time zones are only considered when they are + really needed. Capabilities include: date-time parsing, formatting, + arithmetic, extraction and updating of components, and rounding. } \seealso{ Useful links: diff --git a/man/posixt-arithmetic.Rd b/man/posixt-arithmetic.Rd index 7fb72f99..164fae57 100644 --- a/man/posixt-arithmetic.Rd +++ b/man/posixt-arithmetic.Rd @@ -197,7 +197,7 @@ heuristic for any reason, you can take control and perform the conversions yourself. For example, you could convert the previous example to a naive-time instead of a sys-time manually with \code{\link[=as_naive_time]{as_naive_time()}}, add 1 second giving \code{"2020-03-08 02:00:00"}, then convert back to a -POSIXct/POSIXlt, dealing with the nonexistent time that get's created by +POSIXct/POSIXlt, dealing with the nonexistent time that gets created by using the \code{nonexistent} argument of \code{as.POSIXct()}. } \examples{ diff --git a/vignettes/clock.Rmd b/vignettes/clock.Rmd index 728f16e3..ad92c58d 100644 --- a/vignettes/clock.Rmd +++ b/vignettes/clock.Rmd @@ -21,7 +21,7 @@ library(clock) library(magrittr) ``` -The goal of this vignette is to introduce you to clock's high-level API, which works directly on R's built-in date-time types, Date and POSIXct. For an overview of all of the functionality in the high-level API, check out the pkgdown reference section, [High Level API](https://r-lib.github.io/clock/reference/index.html#section-high-level-api). One thing you should immediately notice is that every function specific to R's date and date-time types are prefixed with `date_*()`. There are also additional functions for arithmetic (`add_*()`) and getting (`get_*()`) or setting (`set_*()`) components that are also used by other types in clock. +The goal of this vignette is to introduce you to clock's high-level API, which works directly on R's built-in date-time types, Date and POSIXct. For an overview of all of the functionality in the high-level API, check out the pkgdown reference section, [High Level API](https://clock.r-lib.org/reference/index.html#section-high-level-api). One thing you should immediately notice is that every function specific to R's date and date-time types are prefixed with `date_*()`. There are also additional functions for arithmetic (`add_*()`) and getting (`get_*()`) or setting (`set_*()`) components that are also used by other types in clock. As you'll quickly see in this vignette, one of the main goals of clock is to guard you, the user, from unexpected issues caused by frustrating date manipulation concepts like invalid dates and daylight saving time. It does this by letting you know as soon as one of these issues happens, giving you the power to handle it explicitly with one of a number of different resolution strategies.