Merge pull request #152 from mpadge/main

Add describe_check function

Author: mpadge

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)

NEWS.md

@@ -1,8 +1,8 @@
 # goodpractice 1.0.5.9000 (dev version)
 
 * goodpractice now uses cli, and no longer depends on crayon and clisymbols (@olivroy, #167).
-
 * If your editor supports it, goodpractice now prints clickable hyperlinks to console.
+- New `describe_check()` function to print descriptions of all implemented checks (@152)
 
 # goodpractice 1.0.5
 

R/lists.R

@@ -10,3 +10,25 @@ CHECKS <- list()
 all_checks <- function() {
   names(CHECKS)
 }
+
+#' Describe one or more checks
+#'
+#' @param check_name Names of checks to be described.
+#' @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)
+#' # Or to see all checks:
+#' \dontrun{
+#'   describe_check(all_checks())
+#' }
+
+describe_check <- function(check_name = NULL) {
+    check_name <- intersect(check_name, names(CHECKS))
+    lapply(CHECKS[check_name], function(i) i$description)
+}