examples expanded

DESCRIPTION

@@ -1,18 +1,17 @@
 Package: retel
 Type: Package
 Title: Regularized Exponentially Tilted Empirical Likelihood
-Version: 0.0.0.9704
+Version: 0.0.0.9705
 Authors@R: c(
     person("Eunseop", "Kim", email = "markean@pm.me", 
-            role = c("aut", "cre")),
+            role = c("aut", "cph", "cre")),
     person("Steven", "MacEachern", role = c("ctb", "ths")),
     person("Mario", "Peruggia", role = c("ctb", "ths"))
   )
 Description: Implements regularized exponentially tilted empirical likelihood 
-    for Bayesian inference. Details of the methods are given in Kim, MacEachern, 
-    and Peruggia (2023) <doi:10.48550/arXiv.2312.17015>. This work was supported 
-    by the U.S. National Science Foundation under Grants No. SES-1921523 and 
-    DMS-2015552.
+    methods. Details of the methods are given in Kim, MacEachern, and Peruggia 
+    (2023) <doi:10.48550/arXiv.2312.17015>. This work was supported by the U.S. 
+    National Science Foundation under Grants No. SES-1921523 and DMS-2015552.
 License: GPL (>= 3)
 URL: https://github.com/markean/retel
 BugReports: https://github.com/markean/retel/issues

R/etel.R

@@ -22,13 +22,20 @@
 #'   "Bayesian Exponentially Tilted Empirical Likelihood."
 #'   \emph{Biometrika}, 92, 31--46.
 #' @examples
+#' # Generate data
 #' set.seed(63456)
-#' f <- function(x, par) {
+#' x <- rnorm(100)
+#'
+#' # Define an estimating function (ex. mean)
+#' fn <- function(x, par) {
 #'   x - par
 #' }
-#' x <- rnorm(100)
+#'
+#' # Set parameter value
 #' par <- 0
-#' etel(f, x, par)
+#'
+#' # Call the etel function
+#' etel(fn, x, par)
 #' @export
 etel <- function(fn, x, par, opts = NULL) {
   assert_function(fn, args = c("x", "par"), ordered = TRUE, nargs = 2L)

R/retel.R

@@ -115,16 +115,25 @@
 #'   "Regularized Exponentially Tilted Empirical Likelihood for Bayesian
 #'   Inference." \doi{10.48550/arXiv.2312.17015}.
 #' @examples
+#' # Generate data
 #' set.seed(63456)
-#' f <- function(x, par) {
+#' x <- rnorm(100)
+#'
+#' # Define an estimating function (ex. mean)
+#' fn <- function(x, par) {
 #'   x - par
 #' }
-#' x <- rnorm(100)
+#'
+#' # Set parameter value
 #' par <- 0
+#'
+#' # Set regularization parameters
 #' mu <- 0
 #' Sigma <- 1
 #' tau <- 1
-#' retel(f, x, par, mu, Sigma, tau)
+#'
+#' # Call the retel function
+#' retel(fn, x, par, mu, Sigma, tau)
 #' @export
 retel <- function(fn, x, par, mu, Sigma, tau, type = "full", opts = NULL) {
   assert_function(fn, args = c("x", "par"), ordered = TRUE, nargs = 2L)