-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from drknexus/develop
Updating Master to Develop for CRAN release
- Loading branch information
Showing
13 changed files
with
430 additions
and
95 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,3 +2,6 @@ | |
| ^\.Rproj\.user$ | ||
| ^\.travis\.yml$ | ||
| ^revdep$ | ||
| cran-comments.md | ||
| ^README\.Rmd$ | ||
| ^README-.*\.png$ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,10 @@ | ||
| # Generated by roxygen2: do not edit by hand | ||
|
|
||
| export(naptime) | ||
| importFrom(lubridate,now) | ||
| importFrom(lubridate,period_to_seconds) | ||
| importFrom(lubridate,seconds) | ||
| importFrom(lubridate,tz) | ||
| importFrom(lubridate,ymd) | ||
| importFrom(lubridate,ymd_hms) | ||
| importFrom(methods,new) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # naptime 1.0.0 | ||
|
|
||
| * Initial CRAN Submission | ||
| * 100% Code Coverage | ||
| * Polymorphism for: | ||
| * numeric | ||
| * NULL | ||
| * POSIXct | ||
| * Period | ||
| * character | ||
| * difftime | ||
| * logical | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| --- | ||
| output: github_document | ||
| --- | ||
| <!-- README.md is generated from README.Rmd. Please edit that file --> | ||
| ```{r, echo = FALSE, results='hide', message=FALSE} | ||
| knitr::opts_chunk$set( | ||
| collapse = TRUE, | ||
| comment = "#>", | ||
| fig.path = "README-" | ||
| ) | ||
| library(naptime) | ||
| library(lubridate) | ||
| ``` | ||
| # naptime: A Robust Flexible Sys.sleep() Replacement | ||
| [](http://www.gnu.org/licenses/gpl-2.0.html) | ||
| [](https://travis-ci.org/drknexus/naptime) | ||
| [](https://cran.r-project.org/package=naptime) | ||
| [](https://codecov.io/github/drknexus/naptime?branch=master) | ||
|
|
||
| # Why should I use it? | ||
|
|
||
| The premise of naptime is two fold. | ||
|
|
||
| 1. Delays in R code should never result in an error. | ||
| 2. Functions should accept multiple inputs types, but result in a single output type. | ||
|
|
||
| In response to these considerations `naptime::naptime()` either sleeps for the specified duration, or passes forward with a warning. It has the same argument name as `base::Sys.sleep()` and a nearly identical behavior in response to numeric inputs. As such, it can be nearly used as a drop-in replacement for `base::Sys.sleep()`. | ||
|
|
||
| The one notable exception to identical behavior is the input value of `Inf`. `base::Sys.sleep()` will sleep indefiniately in reponse to `Inf`. In contrast, `naptime::naptime()` will sleep the default duration. | ||
|
|
||
| # How do I use it? | ||
|
|
||
| ## Options | ||
| All options are set via `base::options()`. | ||
|
|
||
| * `naptime.default_delay`. If left unchanged, the default delay is `.1` seconds. | ||
| * `naptime.warnings`. If left unchanged, the default is `TRUE`, to show warnings. | ||
|
|
||
| # Polymorphic inputs | ||
| naptime() accepts a wide variety of inputs. | ||
|
|
||
| Polymorphism for: | ||
| * numeric: time in seconds to nap | ||
| ```{r} | ||
| naptime(1) | ||
| ``` | ||
| * NULL | ||
| ```{r} | ||
| naptime(NULL) | ||
| ``` | ||
| * POSIXct: time at which the nap should stop (timezone is respected) | ||
| ```{r} | ||
| naptime(lubridate::now(tzone = "UTC")+lubridate::seconds(1)) | ||
| ``` | ||
| * Period: time from now at which the nap should stop | ||
| ```{r} | ||
| naptime(lubridate::seconds(1)) | ||
| ``` | ||
| * character: ymd_hms at which nap should stop, time zone is assumed to be the local timezone if discoverable, otherwise UTC | ||
| ```{r} | ||
| naptime(as.character(lubridate::now() + lubridate::seconds(1))) | ||
| ``` | ||
| * difftime: difference in time to nap | ||
| ```{r} | ||
| naptime(difftime(lubridate::now() + seconds(1), lubridate::now())) | ||
| ``` | ||
| * logical: nap for default duration | ||
| ```{r} | ||
| naptime(TRUE) | ||
| ``` | ||
| * generic: nap for default duration | ||
| ```{r} | ||
| naptime(glm(rnorm(5) ~ rnorm(5))) | ||
| ``` | ||
| If you find a reasonable input-type for which `naptime::naptime()` doesn't have a reasonable response, please file [an issue](https://github.com/drknexus/naptime/issues). | ||
|
|
||
| In addition, naptime will handle some specific errors: | ||
|
|
||
| * All negative intervals will be converted to a delay of 0 | ||
| * All non-finite intervals will be converted to a default delay | ||
| * All inputs that produce an error will be converted to a default delay | ||
|
|
||
| # How do I get it? | ||
| ``` | ||
| library(devtools) | ||
| install_github("drknexus/naptime") | ||
| library(naptime) | ||
| ``` | ||
|
|
||
| # Author's Note | ||
| The initial draft of this code was written by Timothy Gann under a spec drafted by Russell Pierce. Many improvements and bug fixes to the original code, all packaging, and all tests were written by Russell Pierce. Russell Pierce is the current maintainer and responsible party for this package. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,116 @@ | ||
| # naptime: A Robust Flexible Sys.sleep Replacement | ||
| [](http://www.gnu.org/licenses/gpl-2.0.html) | ||
| [](https://travis-ci.org/drknexus/naptime) | ||
| [](http://cran.r-project.org/package=naptime) | ||
| [](https://codecov.io/github/drknexus/naptime?branch=master) | ||
|
|
||
| The premise of naptime is two fold. | ||
| <!-- README.md is generated from README.Rmd. Please edit that file --> | ||
| naptime: A Robust Flexible Sys.sleep() Replacement | ||
| ================================================== | ||
|
|
||
| 1. Delays in R code should never result in an error. | ||
| 2. Functions should accept multiple inputs types, but result in a single output type. | ||
| [](http://www.gnu.org/licenses/gpl-2.0.html) [](https://travis-ci.org/drknexus/naptime) [](https://cran.r-project.org/package=naptime) [](https://codecov.io/github/drknexus/naptime?branch=master) | ||
|
|
||
| In response to these considerations `naptime::naptime()` either sleeps for the specified duration, or passes forward with a warning. It has the same argument name as `base::Sys.sleep()` and a nearly identical behavior in response to numeric inputs. As such, it can be nearly used as a drop-in replacement for `base::Sys.sleep()`. | ||
| Why should I use it? | ||
| ==================== | ||
|
|
||
| The one notable exception to identical behavior is the input value of `Inf`. `base::Sys.sleep()` will sleep indefiniately in reponse to `Inf`. In contrast, `naptime::naptime()` will sleep the default duration. | ||
| The premise of naptime is two fold. | ||
|
|
||
| # Options | ||
| All options are set via base::options(). | ||
| 1. Delays in R code should never result in an error. | ||
| 2. Functions should accept multiple inputs types, but result in a single output type. | ||
|
|
||
| * `naptime.default_delay`. If left unchanged, the default delay is `.1` seconds. | ||
| * `naptime.warnings`. If left unchanged, the default is `TRUE`, to show warnings. | ||
| In response to these considerations `naptime::naptime()` either sleeps for the specified duration, or passes forward with a warning. It has the same argument name as `base::Sys.sleep()` and a nearly identical behavior in response to numeric inputs. As such, it can be nearly used as a drop-in replacement for `base::Sys.sleep()`. | ||
|
|
||
| # Polymorphic inputs | ||
| naptime() accepts a wide variety of inputs. If you find a reasonable input-type for which `naptime::naptime()` doesn't have a reasonable response, please file [an issue](https://github.com/drknexus/naptime/issues). | ||
| The one notable exception to identical behavior is the input value of `Inf`. `base::Sys.sleep()` will sleep indefiniately in reponse to `Inf`. In contrast, `naptime::naptime()` will sleep the default duration. | ||
|
|
||
| * `numeric` Time in seconds | ||
| How do I use it? | ||
| ================ | ||
|
|
||
| Options | ||
| ------- | ||
|
|
||
| ```r | ||
| All options are set via `base::options()`. | ||
|
|
||
| - `naptime.default_delay`. If left unchanged, the default delay is `.1` seconds. | ||
| - `naptime.warnings`. If left unchanged, the default is `TRUE`, to show warnings. | ||
|
|
||
| Polymorphic inputs | ||
| ================== | ||
|
|
||
| naptime() accepts a wide variety of inputs. | ||
|
|
||
| Polymorphism for: \* numeric: time in seconds to nap | ||
|
|
||
| ``` r | ||
| naptime(1) | ||
| ``` | ||
|
|
||
| * `Period` Any positive time difference regardless of units | ||
| * `character` A time in the format of yyyy-mm-dd hh:mm:ss UTC. | ||
| - NULL | ||
|
|
||
| ``` r | ||
| naptime(NULL) | ||
| #> Warning in nap_warn("NULL passed to naptime(), sleeping for .Options | ||
| #> $naptime.default_delay seconds."): NULL passed to naptime(), sleeping | ||
| #> for .Options$naptime.default_delay seconds. | ||
| #> [1] 0.1 | ||
| ``` | ||
|
|
||
| - POSIXct: time at which the nap should stop (timezone is respected) | ||
|
|
||
| ``` r | ||
| naptime(lubridate::now()+lubridate::seconds(1)) | ||
| ``` | ||
|
|
||
| - Period: time from now at which the nap should stop | ||
|
|
||
| ``` r | ||
| naptime(lubridate::seconds(1)) | ||
| ``` | ||
|
|
||
| - character: ymd\_hms at which nap should stop, time zone is assumed to be the local timezone if discoverable, otherwise UTC | ||
|
|
||
| ``` r | ||
| naptime(as.character(lubridate::now() + lubridate::seconds(1))) | ||
| ``` | ||
|
|
||
| - difftime: difference in time to nap | ||
|
|
||
| ``` r | ||
| naptime(difftime(lubridate::now() + seconds(1), lubridate::now())) | ||
| ``` | ||
|
|
||
| - logical: nap for default duration | ||
|
|
||
| ``` r | ||
| naptime(TRUE) | ||
| #> Warning in nap_warn("Logical passed to naptime(), sleeping for 0 | ||
| #> seconds."): Logical passed to naptime(), sleeping for 0 seconds. | ||
| #> [1] 0.1 | ||
| ``` | ||
|
|
||
| - generic: nap for default duration | ||
|
|
||
| ``` r | ||
| naptime(glm(rnorm(5) ~ rnorm(5))) | ||
| #> Warning in model.matrix.default(mt, mf, contrasts): the response appeared | ||
| #> on the right-hand side and was dropped | ||
| #> Warning in model.matrix.default(mt, mf, contrasts): problem with term 1 in | ||
| #> model.matrix: no columns are assigned | ||
| #> Warning in nap_warn("unhandled input for naptime: ", as.character(e), "; sleeping for default duration"): unhandled input for naptime: Error in (function (classes, fdef, mtable) : unable to find an inherited method for function 'naptime' for signature '"glm"' | ||
| #> ; sleeping for default duration | ||
| #> [1] 0.1 | ||
| ``` | ||
|
|
||
| If you find a reasonable input-type for which `naptime::naptime()` doesn't have a reasonable response, please file [an issue](https://github.com/drknexus/naptime/issues). | ||
|
|
||
| In addition, naptime will handle some specific errors: | ||
| * All negative intervals will be converted to a delay of 0 | ||
| * All non-finite intervals will be converted to a default delay | ||
| * All inputs that produce an error will be converted to a default delay | ||
|
|
||
| - All negative intervals will be converted to a delay of 0 | ||
| - All non-finite intervals will be converted to a default delay | ||
| - All inputs that produce an error will be converted to a default delay | ||
|
|
||
| How do I get it? | ||
| ================ | ||
|
|
||
| library(devtools) | ||
| install_github("drknexus/naptime") | ||
| library(naptime) | ||
|
|
||
| Author's Note | ||
| ============= | ||
|
|
||
| The initial draft of this code was written by Timothy Gann under a spec drafted by Russell Pierce. Many improvements and bug fixes to the original code, all packaging, and all tests were written by Russell Pierce. Russell Pierce is the current maintainer and responsible party for this package. |
Oops, something went wrong.