Skip to contents

List all checks performed

Usage

checks(gp)

Arguments

gp

gp output.

Value

Character vector of check names.

See also

Examples

path <- system.file("bad1", package = "goodpractice")
# Run a subset of all checks available
g <- gp(path, checks = all_checks()[9:16])
#> ── Preparing goodpractice for badpackage ───────────────────────────────────────
#>  Preparing: description
#>  Preparing: description [13ms]
#> 
checks(g)
#> [1] "no_description_depends"             "no_description_date"               
#> [3] "description_url"                    "description_not_start_with_package"
#> [5] "description_urls_in_angle_brackets" "description_doi_format"            
#> [7] "description_urls_not_http"          "no_description_duplicate_deps"     
# Or run with named check groups
g <- gp(path, checks = checks_by_group("description", "namespace"))
#> ── Preparing goodpractice for badpackage ───────────────────────────────────────
#>  Preparing: description
#>  Preparing: description [11ms]
#> 
#>  Preparing: namespace
#>  Preparing: namespace [9ms]
#> 
#>  Preparing: rd
#>  Preparing: rd [8ms]
#> 
#>  Preparing: revdep
#>  Preparing: revdep [1.3s]
#> 
#>  Preparing: tidyverse
#>  Preparing: tidyverse [216ms]
#> 
checks(g)
#>  [1] "no_obsolete_deps"                   "complexity_unused_internal"        
#>  [3] "no_description_depends"             "no_description_date"               
#>  [5] "description_url"                    "description_not_start_with_package"
#>  [7] "description_urls_in_angle_brackets" "description_doi_format"            
#>  [9] "description_urls_not_http"          "no_description_duplicate_deps"     
#> [11] "description_valid_roles"            "description_pkgname_single_quoted" 
#> [13] "description_bugreports"             "no_import_package_as_a_whole"      
#> [15] "no_export_pattern"                  "rd_has_examples"                   
#> [17] "rd_has_return"                      "reverse_dependencies"              
#> [19] "tidyverse_export_order"