CRAN resubmission

* Documentation fixes for CRAN checks.

.Rbuildignore

@@ -12,3 +12,4 @@
 ^cache$
 ^\.github$
 ^cran-comments\.md$
+^CRAN-SUBMISSION$

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: debkeepr
 Title: Analysis of Non-Decimal Currencies and Double-Entry Bookkeeping
-Version: 0.1.0
+Version: 0.1.1
 Authors@R: 
     person("Jesse", "Sadler", , "[email protected]", role = c("aut", "cre", "cph"),
            comment = c(ORCID = "0000-0001-6081-9681"))
@@ -33,6 +33,7 @@ Suggests:
     igraph,
     knitr,
     rmarkdown,
+    roxygen2,
     scales (>= 1.1.0),
     testthat (>= 3.1.3)
 VignetteBuilder: 

NEWS.md

@@ -1,4 +1,9 @@
+# debkeepr 0.1.1
+
+- Documentation fixes for CRAN checks.
+
 # debkeepr 0.1.0
+
 - Prep for CRAN release.
 - Transaction functions now return a data.frame if input is data.frame.
 - Make all tests self-sufficient.

R/arithmetic.R

@@ -4,6 +4,8 @@
 #' @param x,y Vectors.
 #' @param op Arithmetic operation.
 #' @param ... For future expansion
+#' @returns A `deb_lsd`, `deb_tetra`, `deb_decimal` or `numeric` vector
+#'   depending on the inputs and arithmetic operator.
 #' @name arithmetic
 NULL
 

R/comparison.R

@@ -5,6 +5,7 @@
 #' Equality and comparison
 #' @param x A deb_lsd vector.
 #' @param ... Arguments passed on to further methods.
+#' @returns A data frame or numeric vector to be used for comparison.
 #' @name comparison
 NULL
 

R/debkeepr-package.R

@@ -15,6 +15,7 @@ NULL
 #' @name %<-%
 #' @rdname multi-assign
 #' @keywords internal
+#' @returns Invisibly returns `value`.
 #' @export
 #' @importFrom zeallot %<-%
 #' @usage x \%<-\% value
@@ -23,14 +24,17 @@ NULL
 
 #' Pipe operator
 #'
-#' See \code{magrittr::\link[magrittr]{\%>\%}} for details.
+#' See \code{magrittr::\link[magrittr:pipe]{\%>\%}} for details.
 #'
 #' @name %>%
 #' @rdname pipe
 #' @keywords internal
 #' @export
 #' @importFrom magrittr %>%
 #' @usage lhs \%>\% rhs
+#' @param lhs A value or the magrittr placeholder.
+#' @param rhs A function call using the magrittr semantics.
+#' @return The result of calling `rhs(lhs)`.
 NULL
 
 #' Tidy eval helpers

R/mathematics.R

@@ -197,6 +197,7 @@ trunc.deb_lsd <- function(x, ...) {
 #' @param .fn A mathematical function from the base package.
 #' @param .x A vector.
 #' @param ... Additional arguments passed to `.fn`.
+#' @returns A `deb_lsd` vector.
 #' @export
 vec_math.deb_lsd <- function(.fn, .x, ...) {
   # Implement sum to allow various types of deb-style vectors in ...
@@ -332,6 +333,7 @@ trunc.deb_tetra <- function(x, ...) {
 #' @param .fn A mathematical function from the base package.
 #' @param .x A vector.
 #' @param ... Additional arguments passed to `.fn`.
+#' @returns A `deb_tetra` vector.
 #' @export
 vec_math.deb_tetra <- function(.fn, .x, ...) {
   # Implement sum to allow various types of deb-style vectors in ...

cran-comments.md

@@ -1,3 +1,19 @@
+## Resubmission
+
+There are currently no references describing the methods in the package. I am currently working on writing a methods paper and will include it in a future update.
+
+This is a resubmission. In this version I have:
+
+* Added \value to the following .Rd files:
+  * arithmetic.Rd
+  * comparison.Rd
+  * multi-assign.Rd
+  * pipe.Rd
+  * vec_math.deb_lsd.Rd
+  * vec_math.deb_tetra.Rd
+
+* I have added \arguments to pipe.Rd
+
 ## R CMD check results
 
 0 errors | 0 warnings | 3 note