expose 'roxygenise' param in report fn; closes #39

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: srr
 Title: 'rOpenSci' Review Roclets
-Version: 0.1.2.006
+Version: 0.1.2.007
 Authors@R: 
     person("Mark", "Padgham", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-2172-5265"))

R/report.R

@@ -7,6 +7,11 @@
 #' @param branch By default a report will be generated from the current branch
 #' as set on the local git repository; this parameter can be used to specify any
 #' alternative branch.
+#' @param roxygenise If `TRUE` (default), documentation will first be updated
+#' with the \pkg{roxygen2} package. This requires local installation of the
+#' package, which may take some time if the package has not previously been
+#' installed. If this parameter is `FALSE`, the `roxygen2` package is not used,
+#' documentation is not updated, and reports are generally generated faster.
 #' @return (invisibly) Markdown-formatted lines used to generate the final html
 #' document.
 #' @family report
@@ -16,16 +21,19 @@
 #' path <- srr_stats_pkg_skeleton ()
 #' srr_report (path)
 #' }
-srr_report <- function (path = ".", branch = "", view = TRUE) {
-
-    o <- utils::capture.output (
-        chk <- tryCatch (
-            roxygen2::roxygenise (path),
-            error = function (e) e
+srr_report <- function (path = ".", branch = "",
+                        view = TRUE, roxygenise = TRUE) {
+
+    if (roxygenise) {
+        o <- utils::capture.output (
+            chk <- tryCatch (
+                roxygen2::roxygenise (path),
+                error = function (e) e
+            )
         )
-    )
-    if (methods::is (chk, "simpleError")) {
-        stop (chk$message)
+        if (methods::is (chk, "simpleError")) {
+            stop (chk$message)
+        }
     }
 
     requireNamespace ("rmarkdown")

codemeta.json

@@ -8,7 +8,7 @@
   "codeRepository": "https://github.com/ropensci-review-tools/srr",
   "issueTracker": "https://github.com/ropensci-review-tools/srr/issues",
   "license": "https://spdx.org/licenses/MIT",
-  "version": "0.1.2.006",
+  "version": "0.1.2.007",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",