From 8126b69d36d973a9b08c80bf677ce3d92d314931 Mon Sep 17 00:00:00 2001 From: Tony Fischetti Date: Mon, 25 Jan 2021 11:28:00 -0500 Subject: [PATCH] CRAN release 2.8. Many improvements. Vignette covers all details... Big thank you to contributors Krystian Igras, Appsilon, Angela (aalucaci), Jeroen Ooms, and everyone else --- CRAN-RELEASE | 2 -- DESCRIPTION | 9 +++++---- README.md | 2 +- cran-comments.md | 6 +++--- man/assert.Rd | 26 ++++++++++++++++++++------ man/assert_rows.Rd | 29 ++++++++++++++++++++++------- man/assertr.Rd | 1 - man/chaining_functions.Rd | 3 +-- man/insist.Rd | 24 +++++++++++++++++++----- man/insist_rows.Rd | 29 ++++++++++++++++++++++------- man/maha_dist.Rd | 3 +-- man/verify.Rd | 13 ++++++++++--- man/within_bounds.Rd | 9 +++++++-- 13 files changed, 111 insertions(+), 45 deletions(-) delete mode 100644 CRAN-RELEASE diff --git a/CRAN-RELEASE b/CRAN-RELEASE deleted file mode 100644 index 7bec63c..0000000 --- a/CRAN-RELEASE +++ /dev/null @@ -1,2 +0,0 @@ -This package was submitted to CRAN on 2019-01-22. -Once it is accepted, delete this file and tag the release (commit e7b6587ab5). diff --git a/DESCRIPTION b/DESCRIPTION index 8ec7744..9e2b4bf 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: assertr Type: Package Title: Assertive Programming for R Analysis Pipelines -Version: 2.7 +Version: 2.8 Authors@R: person("Tony", "Fischetti", email="tony.fischetti@gmail.com", role = c("aut", "cre")) @@ -10,7 +10,7 @@ Description: Provides functionality to assert conditions analysis pipelines can fail quickly. Similar to 'stopifnot()' but more powerful, friendly, and easier for use in pipelines. -URL: https://docs.ropensci.org/assertr (website) +URL: https://docs.ropensci.org/assertr/ (website) https://github.com/ropensci/assertr BugReports: https://github.com/ropensci/assertr/issues License: MIT + file LICENSE @@ -26,7 +26,8 @@ Imports: Suggests: knitr, testthat, - magrittr + magrittr, + rmarkdown VignetteBuilder: knitr -RoxygenNote: 6.1.1 +RoxygenNote: 7.1.1 Encoding: UTF-8 diff --git a/README.md b/README.md index 1ea75cd..0397e5c 100644 --- a/README.md +++ b/README.md @@ -182,4 +182,4 @@ For more info, check out the `assertr` vignette ``` Or [read it here](https://CRAN.R-project.org/package=assertr/vignettes/assertr.html) -# [![ropensci\_footer](https://ropensci.org/public_images/github_footer.png)](http://ropensci.org) +# [![ropensci\_footer](https://ropensci.org/public_images/github_footer.png)](https://ropensci.org/) diff --git a/cran-comments.md b/cran-comments.md index 6d7c603..2fed909 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,7 +1,7 @@ ## Test environments -* local macOS Sierra 10.14 install, R 3.5.2 -* ubuntu (on travis-ci), R 3.5.1 -* win-builder (devel and release) +* local Debian 10 (buster) install, R 4.0.0 +* local macOS High Sierra 10.13 install, R 4.0.3 +* win-builder (devel, release, and old_release) ## R CMD check results diff --git a/man/assert.Rd b/man/assert.Rd index d5622da..aa1ba4e 100644 --- a/man/assert.Rd +++ b/man/assert.Rd @@ -5,12 +5,26 @@ \alias{assert_} \title{Raises error if predicate is FALSE in any columns selected} \usage{ -assert(data, predicate, ..., success_fun = success_continue, - error_fun = error_stop, skip_chain_opts = FALSE, - obligatory = FALSE, defect_fun = defect_append, description = NA) - -assert_(data, predicate, ..., .dots, success_fun = success_continue, - error_fun = error_stop) +assert( + data, + predicate, + ..., + success_fun = success_continue, + error_fun = error_stop, + skip_chain_opts = FALSE, + obligatory = FALSE, + defect_fun = defect_append, + description = NA +) + +assert_( + data, + predicate, + ..., + .dots, + success_fun = success_continue, + error_fun = error_stop +) } \arguments{ \item{data}{A data frame} diff --git a/man/assert_rows.Rd b/man/assert_rows.Rd index 93bea2c..025d20c 100644 --- a/man/assert_rows.Rd +++ b/man/assert_rows.Rd @@ -6,13 +6,28 @@ \title{Raises error if predicate is FALSE for any row after applying row reduction function} \usage{ -assert_rows(data, row_reduction_fn, predicate, ..., - success_fun = success_continue, error_fun = error_stop, - skip_chain_opts = FALSE, obligatory = FALSE, - defect_fun = defect_append, description = NA) - -assert_rows_(data, row_reduction_fn, predicate, ..., .dots, - success_fun = success_continue, error_fun = error_stop) +assert_rows( + data, + row_reduction_fn, + predicate, + ..., + success_fun = success_continue, + error_fun = error_stop, + skip_chain_opts = FALSE, + obligatory = FALSE, + defect_fun = defect_append, + description = NA +) + +assert_rows_( + data, + row_reduction_fn, + predicate, + ..., + .dots, + success_fun = success_continue, + error_fun = error_stop +) } \arguments{ \item{data}{A data frame} diff --git a/man/assertr.Rd b/man/assertr.Rd index a8ed5be..43152d6 100644 --- a/man/assertr.Rd +++ b/man/assertr.Rd @@ -3,7 +3,6 @@ \docType{package} \name{assertr} \alias{assertr} -\alias{assertr-package} \title{assertr: Assertive programming for R analysis pipeline.} \description{ The assertr package supplies a suite of functions designed to verify diff --git a/man/chaining_functions.Rd b/man/chaining_functions.Rd index 7f1dad3..01ccf01 100644 --- a/man/chaining_functions.Rd +++ b/man/chaining_functions.Rd @@ -8,8 +8,7 @@ \usage{ chain_start(data, store_success = FALSE) -chain_end(data, success_fun = success_continue, - error_fun = error_report) +chain_end(data, success_fun = success_continue, error_fun = error_report) } \arguments{ \item{data}{A data frame} diff --git a/man/insist.Rd b/man/insist.Rd index 2600fb4..a867e12 100644 --- a/man/insist.Rd +++ b/man/insist.Rd @@ -6,12 +6,26 @@ \title{Raises error if dynamically created predicate is FALSE in any columns selected} \usage{ -insist(data, predicate_generator, ..., success_fun = success_continue, - error_fun = error_stop, skip_chain_opts = FALSE, - obligatory = FALSE, defect_fun = defect_append, description = NA) +insist( + data, + predicate_generator, + ..., + success_fun = success_continue, + error_fun = error_stop, + skip_chain_opts = FALSE, + obligatory = FALSE, + defect_fun = defect_append, + description = NA +) -insist_(data, predicate_generator, ..., .dots, - success_fun = success_continue, error_fun = error_stop) +insist_( + data, + predicate_generator, + ..., + .dots, + success_fun = success_continue, + error_fun = error_stop +) } \arguments{ \item{data}{A data frame} diff --git a/man/insist_rows.Rd b/man/insist_rows.Rd index 34f0087..50d088f 100644 --- a/man/insist_rows.Rd +++ b/man/insist_rows.Rd @@ -6,13 +6,28 @@ \title{Raises error if dynamically created predicate is FALSE for any row after applying row reduction function} \usage{ -insist_rows(data, row_reduction_fn, predicate_generator, ..., - success_fun = success_continue, error_fun = error_stop, - skip_chain_opts = FALSE, obligatory = FALSE, - defect_fun = defect_append, description = NA) - -insist_rows_(data, row_reduction_fn, predicate_generator, ..., .dots, - success_fun = success_continue, error_fun = error_stop) +insist_rows( + data, + row_reduction_fn, + predicate_generator, + ..., + success_fun = success_continue, + error_fun = error_stop, + skip_chain_opts = FALSE, + obligatory = FALSE, + defect_fun = defect_append, + description = NA +) + +insist_rows_( + data, + row_reduction_fn, + predicate_generator, + ..., + .dots, + success_fun = success_continue, + error_fun = error_stop +) } \arguments{ \item{data}{A data frame} diff --git a/man/maha_dist.Rd b/man/maha_dist.Rd index dad9fd0..c0e360c 100644 --- a/man/maha_dist.Rd +++ b/man/maha_dist.Rd @@ -4,8 +4,7 @@ \alias{maha_dist} \title{Computes mahalanobis distance for each row of data frame} \usage{ -maha_dist(data, keep.NA = TRUE, robust = FALSE, - stringsAsFactors = FALSE) +maha_dist(data, keep.NA = TRUE, robust = FALSE, stringsAsFactors = FALSE) } \arguments{ \item{data}{A data frame} diff --git a/man/verify.Rd b/man/verify.Rd index 266148a..df97717 100644 --- a/man/verify.Rd +++ b/man/verify.Rd @@ -4,9 +4,16 @@ \alias{verify} \title{Raises error if expression is FALSE anywhere} \usage{ -verify(data, expr, success_fun = success_continue, - error_fun = error_stop, skip_chain_opts = FALSE, - obligatory = FALSE, defect_fun = defect_append, description = NA) +verify( + data, + expr, + success_fun = success_continue, + error_fun = error_stop, + skip_chain_opts = FALSE, + obligatory = FALSE, + defect_fun = defect_append, + description = NA +) } \arguments{ \item{data}{A data frame, list, or environment} diff --git a/man/within_bounds.Rd b/man/within_bounds.Rd index a67dd8a..b734d07 100644 --- a/man/within_bounds.Rd +++ b/man/within_bounds.Rd @@ -4,8 +4,13 @@ \alias{within_bounds} \title{Creates bounds checking predicate} \usage{ -within_bounds(lower.bound, upper.bound, include.lower = TRUE, - include.upper = TRUE, allow.na = TRUE) +within_bounds( + lower.bound, + upper.bound, + include.lower = TRUE, + include.upper = TRUE, + allow.na = TRUE +) } \arguments{ \item{lower.bound}{The lowest permitted value}