Set config for docreview checks
get_config( config_path = system.file("configs", "docreview.yml", package = "docreview", mustWork = TRUE) )
| config_path | Path to config file |
|---|
# Get default configuration get_config()#> $error_on_failure #> [1] FALSE #> #> $error_on_warning #> [1] FALSE #> #> $vignettes #> $vignettes$active #> [1] TRUE #> #> $vignettes$`flesch-kincaid` #> $vignettes$`flesch-kincaid`$active #> [1] TRUE #> #> $vignettes$`flesch-kincaid`$warn #> [1] 50 #> #> $vignettes$`flesch-kincaid`$fail #> [1] 30 #> #> #> $vignettes$length #> $vignettes$length$active #> [1] TRUE #> #> $vignettes$length$too_long #> $vignettes$length$too_long$active #> [1] TRUE #> #> $vignettes$length$too_long$warn #> [1] 2000 #> #> $vignettes$length$too_long$fail #> [1] 3000 #> #> #> $vignettes$length$too_short #> $vignettes$length$too_short$active #> [1] TRUE #> #> $vignettes$length$too_short$warn #> [1] 100 #> #> $vignettes$length$too_short$fail #> [1] 0 #> #> #> #> $vignettes$problem_words #> $vignettes$problem_words$active #> [1] FALSE #> #> #> $vignettes$image_alt_text #> $vignettes$image_alt_text$active #> [1] TRUE #> #> $vignettes$image_alt_text$fail #> [1] 1 #> #> $vignettes$image_alt_text$warn #> [1] 1 #> #> $vignettes$image_alt_text$min_chars #> [1] 10 #> #> $vignettes$image_alt_text$html_required #> [1] TRUE #> #> #> #> $functions #> $functions$active #> [1] TRUE #> #> $functions$exports_without_examples #> $functions$exports_without_examples$active #> [1] TRUE #> #> $functions$exports_without_examples$warn #> [1] 1 #> #> $functions$exports_without_examples$fail #> [1] 1 #> #> $functions$exports_without_examples$min_arity #> [1] 1 #> #> #>