export 'srr_counts_from_report' fn

ropensci-review-tools · Sep 16, 2024 · 5726342 · 5726342
1 parent a709ddd
commit 5726342
Show file tree

Hide file tree

Showing 11 changed files with 18 additions and 3 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: roreviewapi
 Title: Plumber API to report package structure and function
-Version: 0.1.0.052
+Version: 0.1.0.053
 Authors@R: 
     person("Mark", "Padgham", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-2172-5265"))

diff --git a/NAMESPACE b/NAMESPACE
@@ -14,6 +14,7 @@ export(readme_badge)
 export(readme_has_peer_review_badge)
 export(serve_api)
 export(srr_counts)
+export(srr_counts_from_report)
 export(srr_counts_summary)
 export(stats_badge)
 export(stdout_stderr_cache)

diff --git a/R/srr.R b/R/srr.R
@@ -48,7 +48,7 @@ srr_counts <- function (repourl, repo, issue_id, post_to_issue = TRUE) {
         return (out)
     }
 
-    out <- srr_counts_from_report (srr_rep)
+    out <- srr::srr_counts_from_report (srr_rep)
 
     if (post_to_issue) {
 
@@ -58,6 +58,13 @@ srr_counts <- function (repourl, repo, issue_id, post_to_issue = TRUE) {
     return (out)
 }
 
+#' Extract final counts of 'srr' standards from the report
+#'
+#' @param srr_rep An 'srr' report generated by the `srr::srr_report()` function.
+#' @return Character vector with markdown-formatted summary summary of numbers
+#' of standards complied with.
+#' @family ropensci
+#' @export
 srr_counts_from_report <- function (srr_rep) {
 
     index <- grep ("heavy_multiplication_x\\:\\s+Error\\:", srr_rep)

diff --git a/codemeta.json b/codemeta.json
@@ -8,7 +8,7 @@
   "codeRepository": "https://github.com/ropensci-review-tools/roreviewapi",
   "issueTracker": "https://github.com/ropensci-review-tools/roreviewapi/issues",
   "license": "https://spdx.org/licenses/GPL-3.0",
-  "version": "0.1.0.052",
+  "version": "0.1.0.053",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",

diff --git a/man/check_issue_template.Rd b/man/check_issue_template.Rd
diff --git a/man/is_user_authorized.Rd b/man/is_user_authorized.Rd
diff --git a/man/push_to_gh_pages.Rd b/man/push_to_gh_pages.Rd
diff --git a/man/readme_has_peer_review_badge.Rd b/man/readme_has_peer_review_badge.Rd
diff --git a/man/srr_counts.Rd b/man/srr_counts.Rd
diff --git a/man/srr_counts_summary.Rd b/man/srr_counts_summary.Rd
diff --git a/man/stats_badge.Rd b/man/stats_badge.Rd