Merge pull request #102 from rapidsurveys:dev

address CRAN comments; uptick to v0.2.3

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: oldr
 Title: An Implementation of Rapid Assessment Method for Older People
-Version: 0.2.2
+Version: 0.2.3
 Authors@R: c(
     person("Mark", "Myatt", comment = c(ORCID = "0000-0003-1119-1474"),
            email = "[email protected]", role = c("aut", "cph")),

NEWS.md

@@ -1,4 +1,4 @@
-# oldr 0.2.2
+# oldr 0.2.3
 
 This is the first CRAN release of `{oldr}`.
 

R/08-report.R

@@ -1083,8 +1083,10 @@ report_op_odt <- function(estimates,
   )
 
   ## Render document in HTML format
-  rmarkdown::render(input = paste(filename, ".Rmd", sep = ""),
-                    output_format = "odt_document")
+  rmarkdown::render(
+    input = paste(filename, ".Rmd", sep = ""),
+    output_format = "odt_document"
+  )
 
   ## Check if report is to be viewed
   if (view) {
@@ -1094,6 +1096,7 @@ report_op_odt <- function(estimates,
 }
 
 
+#' 
 #' Create a PDF report document containing RAM-OP survey results
 #'
 #' @param estimates A data.frame of RAM-OP results produced by [merge_op()].
@@ -1108,17 +1111,17 @@ report_op_odt <- function(estimates,
 #'   to a specified directory.
 #'
 #' @examples
-#' if (FALSE) {
-#'   classicResults <- estimate_classic(
-#'     x = create_op(testSVY), w = testPSU, replicates = 9
-#'   )
+#' classicResults <- estimate_classic(
+#'   x = create_op(testSVY), w = testPSU, replicates = 3
+#' )
 #'
-#'   probitResults <- estimate_probit(
-#'     x = create_op(testSVY), w = testPSU, replicates = 9
-#'   )
+#' probitResults <- estimate_probit(
+#'   x = create_op(testSVY), w = testPSU, replicates = 3
+#' )
 #'
-#'   resultsDF <- merge_op(x = classicResults, y = probitResults)
+#' resultsDF <- merge_op(x = classicResults, y = probitResults)
 #'
+#' \donttest{
 #'   report_op_pdf(
 #'     svy = testSVY, estimates = resultsDF, indicators = "mental",
 #'     filename = paste(tempdir(), "report", sep = "/")

README.md

@@ -95,7 +95,7 @@ citation("oldr")
 #>   Mark Myatt, Ernest Guevarra, Pascale Fritsch, Katja Siling (2025).
 #>   _oldr: An Implementation of Rapid Assessment Method for Older
 #>   People_. doi:10.5281/zenodo.7505731
-#>   <https://doi.org/10.5281/zenodo.7505731>, R package version 0.2.2,
+#>   <https://doi.org/10.5281/zenodo.7505731>, R package version 0.2.3,
 #>   <https://rapidsurveys.io/oldr/>.
 #> 
 #> A BibTeX entry for LaTeX users is
@@ -104,7 +104,7 @@ citation("oldr")
 #>     title = {oldr: An Implementation of Rapid Assessment Method for Older People},
 #>     author = {{Mark Myatt} and {Ernest Guevarra} and {Pascale Fritsch} and {Katja Siling}},
 #>     year = {2025},
-#>     note = {R package version 0.2.2},
+#>     note = {R package version 0.2.3},
 #>     url = {https://rapidsurveys.io/oldr/},
 #>     doi = {10.5281/zenodo.7505731},
 #>   }

cran-comments.md

@@ -14,6 +14,10 @@ In this resubmission, I addressed the following comments from CRAN:
 
     - I removed `\dontrun{}` from the example for the `merge_op()` function.
 
+* `if (FALSE)` in examples should never be used
+
+    - I removed the `if (FALSE)` example in the `report_op_pdf()` function
+    documentation and added `donttest{}` as the example takes longer than 5s.
 
 ## Test environments
 * local OS X install, R 4.4.2

inst/CITATION

@@ -4,7 +4,7 @@ bibentry(
   title    = "oldr: An Implementation of Rapid Assessment Method for Older People",
   author   = c(person("Mark Myatt"), person("Ernest Guevarra"), person("Pascale Fritsch"), person("Katja Siling")),
   year     = "2025",
-  note     = "R package version 0.2.2",
+  note     = "R package version 0.2.3",
   url      = "https://rapidsurveys.io/oldr/",
   doi      = "10.5281/zenodo.7505731"
 )