Skip to content

Commit

Permalink
Address CRAN reviewer's comments
Browse files Browse the repository at this point in the history
  • Loading branch information
benjaminrich committed Mar 14, 2022
1 parent 224c71a commit 7c90a46
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 0 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
.*\.bak$
^README\.Rmd$
^README\.html$
^CRAN-SUBMISSION$
3 changes: 3 additions & 0 deletions CRAN-SUBMISSION
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Version: 0.5.0
Date: 2022-03-13 17:13:25 UTC
SHA: 224c71a2f7a7c8fcfebf499494a2a66e998ba356
5 changes: 5 additions & 0 deletions R/pmxpartab.R
Original file line number Diff line number Diff line change
Expand Up @@ -527,6 +527,10 @@ partab_row <- function(
#' @param digits Number of significant digits to include in the formatted
#' table.
#'
#' @return An object of class `"pmxpartab"`. This is essentially just an HTML
#' character string that displays in the default web browser or viewer when
#' printed (as per [htmltools::print.html()]).
#'
#' @seealso [pmxparframe]
#'
#' @examples
Expand Down Expand Up @@ -748,6 +752,7 @@ parse_parameter_description <- function(string) {
#' @param unicode.le A logical flag indicating whether to use unicode
#' symbol [U+2264](https://www.compart.com/en/unicode/U+2264)
#' for "less-than-or-equal-to" (only applies when `html` is `FALSE`).
#' @return A character vector of the same length as `pval`.
#' @seealso [base::format.pval]
#' @examples
#' x <- c(1, 0.5, 0.05, 0.049, 0.01, 0.001, 0.0001, 0.00001)
Expand Down
14 changes: 14 additions & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@

This is the first submission of `pmxpartab` to CRAN.

Addressed the following comments from CRAN reviewer:

* From: Julia Haider <julia.haider@wu.ac.at> on 14-Mar-2022:

- Please add \value to .Rd files regarding exported methods and explain the
functions results in the documentation. Please write about the structure of
the output (class) and also what the output means. (If a function does not
return a value, please document that too, e.g. \value{No return value, called
for side effects} or similar)

Missing Rd-tags:
* fpval.Rd: \value
* pmxpartab.Rd: \value

## Test environments

* Local:
Expand Down
3 changes: 3 additions & 0 deletions man/fpval.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions man/pmxpartab.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 7c90a46

Please sign in to comment.