Minor updates after CRAN review

Author: kenkellner

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: nimbleMacros
-Version: 0.1.0
-Date: 2025-03-05
+Version: 0.1.1
+Date: 2025-03-10
 Title: Macros Generating 'nimble' Code
 Authors@R: c(person("Ken", "Kellner", email="contact@kenkellner.com", 
                     role=c("cre","aut")),
@@ -16,7 +16,7 @@ Suggests:
     knitr,
     markdown,
     testthat
-Description: Macros to generate 'nimble' code from a concise syntax. Included are macros for generating linear modeling code using a formula-based syntax and for 'for' loops.
+Description: Macros to generate 'nimble' code from a concise syntax. Included are macros for generating linear modeling code using a formula-based syntax and for building for() loops. For more details review the 'nimble' manual: <https://r-nimble.org/html_manual/cha-writing-models.html#subsec:macros>.
 License: BSD_3_clause + file LICENSE | GPL (>= 2)
 NeedsCompilation: no
 URL: https://r-nimble.org

NEWS.md

@@ -0,0 +1,8 @@
+# unmarked 0.1.1
+
+* Add URL to DESCRIPTION
+* Add return value tags to documentation
+
+# nimbleMacros 0.1.0
+
+* Initial release

R/FORLOOP.R

@@ -13,6 +13,8 @@
 #' @param modelInfo Used internally by nimbleMacros; a list of model information such as constants and dimensions
 #' @param .env Used internally by nimbleMacros; the environment where the model was created
 #'
+#' @return NIMBLE code for a for loop or series of nested for loops.
+#'
 #' @examples
 #' code <- nimbleCode({
 #'    y[1:n, 1:2, 1] ~ FORLOOP(dnorm(mu[1:n], sigma))

R/LINPRED.R

@@ -40,6 +40,8 @@
 #' @param modelInfo Used internally by nimbleMacros; a list of model information such as constants and dimensions
 #' @param .env Used internally by nimbleMacros; the environment where the model was created
 #'
+#' @return NIMBLE code for the linear predictor specified by the formula, and optionally the associated priors.
+#'
 #' @author Ken Kellner
 #'
 #' @examples
@@ -144,7 +146,9 @@ unpackArgs=TRUE
 #'  is unrelated to the \code{noncentered} argument despite the similar names.
 #' @param modelInfo Used internally by nimbleMacros; a list of model information such as constants and dimensions
 #' @param .env Used internally by nimbleMacros; the environment where the model was created
-#' 
+#'
+#' @return NIMBLE code for the priors specified by the formula.
+#'
 #' @author Ken Kellner
 #'
 #' @examples
@@ -1433,8 +1437,10 @@ correlatedRandomPrior <- function(x, priorSpecs, sdPrefix, sd_name, modelInfo, c
 #' @param mat upper triangular Cholesky factor of correlation matrix ("Ustar")
 #' @param vec vector of standard deviations for individual random effects
 #'
+#' @return The upper triangular Cholesky factor of the covariance matrix.
+#'
 #' @name uppertri_mult_diag
-
+#'
 #' @importFrom nimble nimMatrix
 #' @export
 uppertri_mult_diag <- nimbleFunction(

R/LM.R

@@ -27,6 +27,8 @@
 #' @param modelInfo Used internally by nimbleMacros; a list of model information such as constants and dimensions
 #' @param .env Used internally by nimbleMacros; the environment where the model was created
 #'
+#' @return NIMBLE code for the linear model, GLM, or GLMM specified by the formula, including priors.
+#'
 #' @author Ken Kellner
 #'
 #' @examples

R/setPriors.R

@@ -19,6 +19,9 @@
 #'  correlation matrix in correlated random slope and intercept models 
 #' @param ... Specific parameters, optionally with brackets/indices
 #'
+#' @return A named list of prior specifications to be passed to the \code{priors}
+#'  argument of other macros in the package, such as \code{LINPRED}.
+#'
 #' @seealso [nimble::dlkj_corr_cholesky] for more on the LKJ distribution
 #'
 #' @details
@@ -122,6 +125,8 @@ removeBracket <- function(node){
 #' @param priors A named list of prior settings, e.g., as generated by
 #'  \code{setPriors}
 #'
+#' @return NIMBLE code for the matching prior.
+#'
 #' @author Ken Kellner
 #'
 #' @examples