From 363f2cd9ccef999a34f940bc982cbb7b3acb674b Mon Sep 17 00:00:00 2001 From: asardaes Date: Thu, 20 Feb 2020 20:12:28 +0100 Subject: [PATCH] Make adjustments according to CRAN feedback --- DESCRIPTION | 9 +++++---- R/pkg.R | 7 ++++--- cran-comments.md | 23 ++++++++++++++++++++++- man/wiserow-package.Rd | 8 +++++--- 4 files changed, 36 insertions(+), 11 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 5f7dee7..eb2cf59 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -3,9 +3,10 @@ Type: Package Title: Multi-Threaded, Coercion-Free Implementations of Common Row-Wise Operations Description: Fast row-oriented operations implemented in C++, all of which are multi-threaded by leveraging 'RcppParallel' and 'RcppThread'. Virtually no deep copies of input data are made, - even of character data thanks to Boost's 'string_ref'. In contrast to other functions, the ones - in this package support data frames with differently typed columns as input without coercion to - a matrix, performing on-the-fly type promotion following R rules, where necessary. + even of character data thanks to the 'string_ref' class from the C++ 'Boost' library. In + contrast to other functions, the ones in this package support data frames with differently typed + columns as input without coercing to a matrix, performing, if necessary, on-the-fly type + promotion according to R rules (like transforming logicals to integers to allow summation). Version: 0.1.0 Depends: R (>= 3.1.0) @@ -22,7 +23,7 @@ LinkingTo: RcppThread Suggests: testthat -Date: 2020-02-10 +Date: 2020-02-20 Authors@R: c( person("Alexis", "Sarda-Espinosa", role=c("cre", "aut"), email="alexis.sarda@gmail.com") ) diff --git a/R/pkg.R b/R/pkg.R index aed2974..076ba3b 100644 --- a/R/pkg.R +++ b/R/pkg.R @@ -2,9 +2,10 @@ #' #' Fast row-oriented operations implemented in C++, all of which are multi-threaded by leveraging #' \pkg{RcppParallel} and \pkg{RcppThread}. Virtually no deep copies of input data are made, even of -#' character data thanks to Boost's `string_ref`. In contrast to other functions, the ones in this -#' package support data frames with differently typed columns as input without coercion to a matrix, -#' performing on-the-fly type promotion following R rules, where necessary. +#' character data thanks to the 'string_ref' class from the C++ 'Boost' library. In contrast to +#' other functions, the ones in this package support data frames with differently typed columns as +#' input without coercing to a matrix, performing, if necessary, on-the-fly type promotion according +#' to R rules (like transforming logicals to integers to allow summation). #' #' Start by looking at [op_ctrl()]. #' diff --git a/cran-comments.md b/cran-comments.md index 3734987..400067b 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,6 +1,27 @@ ## Initial release -This is the first version of the package. +This is the 1st revision for the initial submission of the package. +The following adjustments have been made based on the received feedback: + +* Single quotes have been added to 'Boost' in the description. + Used packages were already quoted. +* The description has been reworded to hopefully make it more understandable. + +Some remarks: + +* All used packages are included in the DESCRIPTION file, + but some are only in the LinkingTo section. + Package 'BH', for instance, doesn't export any functions, + so it couldn't be included in Depends or Imports. +* No specific functions are mentioned in the description. + 'string_ref' is a class, not a function; + this detail has been added to the description. +* 'Type promotion according to R rules' means that, for example, + an integer and a logical can be added together by promoting the logical to an integer. + R has some particularities in this regard, e.g., + promoting a logical to a character results in the strings 'TRUE' or 'FALSE'. + This has been taken into account in the package, + and the description now mentions a simple example thereof. ## Test environments * Local GNU/Linux, R release diff --git a/man/wiserow-package.Rd b/man/wiserow-package.Rd index ad70ecd..8732ae1 100644 --- a/man/wiserow-package.Rd +++ b/man/wiserow-package.Rd @@ -8,9 +8,10 @@ \description{ Fast row-oriented operations implemented in C++, all of which are multi-threaded by leveraging \pkg{RcppParallel} and \pkg{RcppThread}. Virtually no deep copies of input data are made, even of -character data thanks to Boost's \code{string_ref}. In contrast to other functions, the ones in this -package support data frames with differently typed columns as input without coercion to a matrix, -performing on-the-fly type promotion following R rules, where necessary. +character data thanks to the 'string_ref' class from the C++ 'Boost' library. In contrast to +other functions, the ones in this package support data frames with differently typed columns as +input without coercing to a matrix, performing, if necessary, on-the-fly type promotion according +to R rules (like transforming logicals to integers to allow summation). } \details{ Start by looking at \code{\link[=op_ctrl]{op_ctrl()}}. @@ -18,6 +19,7 @@ Start by looking at \code{\link[=op_ctrl]{op_ctrl()}}. \seealso{ Useful links: \itemize{ + \item \url{https://asardaes.github.io/wiserow/} \item \url{https://github.com/asardaes/wiserow} \item Report bugs at \url{https://github.com/asardaes/wiserow/issues} }