diff --git a/.Rbuildignore b/.Rbuildignore index 3915377..74f13a4 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -6,3 +6,4 @@ .*\.bak$ ^README\.Rmd$ ^README\.html$ +^CRAN-SUBMISSION$ diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION new file mode 100644 index 0000000..fe0edfd --- /dev/null +++ b/CRAN-SUBMISSION @@ -0,0 +1,3 @@ +Version: 0.5.0 +Date: 2022-03-13 17:13:25 UTC +SHA: 224c71a2f7a7c8fcfebf499494a2a66e998ba356 diff --git a/R/pmxpartab.R b/R/pmxpartab.R index 8c7373c..b9c3d2a 100644 --- a/R/pmxpartab.R +++ b/R/pmxpartab.R @@ -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 @@ -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) diff --git a/cran-comments.md b/cran-comments.md index a2157ea..7093dc2 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -2,6 +2,20 @@ This is the first submission of `pmxpartab` to CRAN. +Addressed the following comments from CRAN reviewer: + +* From: Julia Haider 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: diff --git a/man/fpval.Rd b/man/fpval.Rd index 0edd1a9..3a027d4 100644 --- a/man/fpval.Rd +++ b/man/fpval.Rd @@ -35,6 +35,9 @@ text.} symbol \href{https://www.compart.com/en/unicode/U+2264}{U+2264} for "less-than-or-equal-to" (only applies when \code{html} is \code{FALSE}).} } +\value{ +A character vector of the same length as \code{pval}. +} \description{ Format p-values } diff --git a/man/pmxpartab.Rd b/man/pmxpartab.Rd index 98bef9a..ff70cef 100644 --- a/man/pmxpartab.Rd +++ b/man/pmxpartab.Rd @@ -51,6 +51,11 @@ missing or non-applicable values.} \item{digits}{Number of significant digits to include in the formatted table.} } +\value{ +An object of class \code{"pmxpartab"}. This is essentially just an HTML +character string that displays in the default web browser or viewer when +printed (as per \code{\link[htmltools:print.html]{htmltools::print.html()}}). +} \description{ Generate an formatted HTML table of parameter estimates }