Improve package documentation

Add return argument to all functions

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: suddengains
 Title: Identify Sudden Gains in Longitudinal Data
-Date: 2023-02-25
-Version: 0.7.1
+Date: 2023-02-27
+Version: 0.7.2
 Authors@R: c(
   person("Milan", "Wiedemann", email = "milan.wiedemann@gmail.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-1991-282X")),
   person("Graham M", "Thew", role = "aut", comment = c(ORCID = "0000-0003-2851-1315")),

R/magrittrpipeoperator.R

@@ -4,6 +4,7 @@
 #' @rdname pipe
 #' @keywords internal
 #' @export
+#' @return Pipe operator %>% from magrittr
 #' @importFrom magrittr %>%
 #' @usage lhs \%>\% rhs
 NULL

R/write_byperson.R

@@ -39,6 +39,7 @@
 #' @param stata_version Numeric, specifying STATA version number.
 #' @references Tang, T. Z., & DeRubeis, R. J. (1999). Sudden gains and critical sessions in cognitive-behavioral therapy for depression. Journal of Consulting and Clinical Psychology, 67(6), 894–904. \doi{10.1037/0022-006X.67.6.894}.
 #' @export
+#' @return A csv file containing a wide data set with one row per case (\code{id_var_name}) in \code{data}.
 #' @examples
 #' # Adjust "path" argument before running
 #' # Create character string name for temporary "byperson.csv" file

R/write_bysg.R

@@ -36,6 +36,7 @@
 #' @param stata_version Numeric, specifying STATA version number.
 #' @references Tang, T. Z., & DeRubeis, R. J. (1999). Sudden gains and critical sessions in cognitive-behavioral therapy for depression. Journal of Consulting and Clinical Psychology, 67(6), 894–904. \doi{10.1037/0022-006X.67.6.894}.
 #' @export
+#' @return A csv file containing a wide data set with one row per sudden gain/loss.
 #' @importFrom rlang :=
 #' @examples # Adjust "path" argument before running
 #' # Create character string name for temporary "bysg.csv" file

cran-comments.md

@@ -8,4 +8,5 @@
 
 ## Resubmission
 This is a resubmission.
-This fix allows to suppress the package startup message.
+This fix adds \value to .Rd files regarding exported methods and explain
+the functions results in the documentation.