add return values for all pcens_df functions in response to CRAN comm…

…ents

NEWS.md

@@ -10,6 +10,7 @@ This is the first major release of `primarycensored` and has been submitted to C
 - Added `dependencies: "hard"` to the `R-CMD-check` workflow to ensure checks pass without optional dependencies.
 - Improved handling of examples that use optional dependencies.
 - Check all URLs for redirects.
+- Ensure that all functions have documented return values.
 
 # primarycensored 0.6.0
 

R/pcens.R

@@ -2,7 +2,11 @@
 #'
 #' @inheritParams pprimarycensored
 #'
-#' @return An object of class `pcens_{pdist_name}_{dprimary_name}`
+#' @return An object of class `pcens_{pdist_name}_{dprimary_name}`. This
+#' contains the primary event distribution, the delay distribution, the
+#' delay distribution arguments, and any additional arguments. It can be
+#' used with the `pcens_cdf()` function to compute the primary event censored
+#' cdf.
 #'
 #' @family pcens
 #'
@@ -47,7 +51,7 @@ new_pcens <- function(
 #' useful for testing purposes or for settings where the analytical solution
 #' breaks down.
 #'
-#' @return Vector of primary event censored CDFs
+#' @return Vector of computed primary event censored CDFs
 #'
 #' @family pcens
 #'
@@ -77,6 +81,8 @@ pcens_cdf <- function(
 #'
 #' @family pcens
 #'
+#' @inherit pcens_cdf return
+#'
 #' @export
 pcens_cdf.default <- function(
     object, q, pwindow, use_numeric = FALSE) {
@@ -109,6 +115,8 @@ pcens_cdf.default <- function(
 #'
 #' @family pcens
 #'
+#' @inherit pcens_cdf return
+#'
 #' @export
 pcens_cdf.pcens_pgamma_dunif <- function(
     object, q, pwindow, use_numeric = FALSE) {
@@ -182,6 +190,8 @@ pcens_cdf.pcens_pgamma_dunif <- function(
 #'
 #' @family pcens
 #'
+#' @inherit pcens_cdf return
+#'
 #' @export
 pcens_cdf.pcens_plnorm_dunif <- function(
     object, q, pwindow, use_numeric = FALSE) {
@@ -252,7 +262,7 @@ pcens_cdf.pcens_plnorm_dunif <- function(
 #'
 #' @inheritParams pcens_cdf
 #'
-#' @family pcens
+#' @inherit pcens_cdf return
 #'
 #' @export
 pcens_cdf.pcens_pweibull_dunif <- function(

cran-comments.md

@@ -3,3 +3,7 @@
 0 errors | 0 warnings | 1 note
 
 * This is a new release.
+
+## Comments
+
+- Ensured that all `pcens_cdf()` functions have documented return values.