screen_folder: Screen All R Files in Folder for Hazardous Code

Description Usage Arguments Value

View source: R/hazmat.R

Description

'screen_folder' applies a set of defined predefined searches (regexps) to all of the R code in all of the R and Rmd files contained in a folder.

Usage

1
screen_folder(path = ".", quiet = FALSE, recurse = FALSE)

Arguments

path

a string, the path to the file to be screened.

quiet

a boolean, if TRUE then console output is suppressed. Defaults FALSE.

recurse

a boolean, if TRUE then sub-directories of 'path' are also checked for R and Rmd files. Defaults to FALSE.

Value

‘screen_folder' is typically called for it’s side effects of printing information about hazardous material to the console. A tibble of the data used to create this message is returned invisibly to enable piping.


actuarialvoodoo/hazmat documentation built on Nov. 25, 2019, 9:26 a.m.