Add describe_check function

NAMESPACE

@@ -3,6 +3,7 @@
 S3method(print,goodPractice)
 export(all_checks)
 export(checks)
+export(describe_check)
 export(export_json)
 export(failed_checks)
 export(failed_positions)

R/lists.R

@@ -10,3 +10,20 @@ CHECKS <- list()
 all_checks <- function() {
   names(CHECKS)
 }
+
+#' Describe one or more checks
+#'
+#' @return List of character descriptions for each \code{check_name}
+#' @export
+#' @examples 
+#' describe_check("rcmdcheck_non_portable_makevars")
+#' check_name <- c ("no_description_depends",
+#'                  "lintr_assignment_linter",
+#'                  "no_import_package_as_a_whole",
+#'                  "rcmdcheck_missing_docs")
+#' describe_check(check_name)
+
+describe_check <- function(check_name = NULL) {
+    check_name <- check_name[check_name %in% names(CHECKS)]
+    lapply(CHECKS[check_name], function(i) i$description)
+} 

tests/testthat/test-describe-check.R

@@ -0,0 +1,27 @@
+
+context("describe check")
+
+test_that("describe_check", {
+    expect_length(describe_check(), 0L)
+    chk <- "rcmdcheck_non_portable_makevars"
+    d <- describe_check(chk)
+    expect_is(d, "list")
+    expect_equal(length(d), length(chk))
+    expect_identical(chk, names(d))
+
+    chk <- c("no_description_depends",
+             "lintr_assignment_linter",
+             "no_import_package_as_a_whole",
+             "rcmdcheck_missing_docs")
+    d <- describe_check(chk)
+    expect_is(d, "list")
+    expect_true(length(d) == length(chk))
+    expect_true(identical(chk, names(d)))
+
+    chk <- c(chk, "a", "b") # "a", "b" are not checks, so ignored
+    d <- describe_check(chk)
+    expect_is(d, "list")
+    expect_false(length(d) == length(chk))
+    expect_false(identical(chk, names(d)))
+    expect_true(length(d) < length(chk))
+})