Diagnose T/F Usage in R Code

Flags bare T / F symbols that should be TRUE / FALSE. Operates on the parsed AST, so T inside string literals or comments is not flagged (a long-standing source of regex false positives). Named-argument names (f(T = 1)) and $T / @T extractions are excluded.

Usage

diagnose_tf_usage(path, verbose = TRUE, parsed = NULL)

Arguments

path

Character. Path to package directory.

verbose

Logical. Print diagnostic messages.

parsed

Internal. Pre-parsed source cache; if NULL, files are read from path on demand.

Value

checktor_check_result() with passed, issues, message.

Examples

# show_content defaults to TRUE, so the offending file prints first
pkg <- example_diagnose_scenario("code_examples/tf_usage_bad.R")
#> === Example file: tf_usage_bad.R ===
#> # Example file showing T/F usage issues
#> 
#> #' Process Data Function
#> #' @param data A data frame
#> #' @return Logical indicating success
#> process_data <- function(data) {
#>   if (is.null(data)) {
#>     return(F) # Issue: should be FALSE
#>   }
#> 
#>   has_complete_cases <- T # Issue: should be TRUE
#> 
#>   if (has_complete_cases) {
#>     cleaned_data <- data[complete.cases(data), ]
#>     return(T) # Issue: should be TRUE
#>   }
#> 
#>   return(F) # Issue: should be FALSE
#> }
#> 
#> # Another function with T/F issues
#> validate_input <- function(x, strict = T) {
#>   # Issue: should be TRUE
#>   if (length(x) == 0) {
#>     return(F)
#>   } # Issue: should be FALSE
#> 
#>   valid <- all(is.numeric(x))
#>   return(valid && strict == T) # Issue: should be TRUE
#> }
#> 
#> === End of example ===
#> 
issues(diagnose_tf_usage(pkg, verbose = FALSE))
#>             file line          location         message
#> 1 tf_usage_bad.R    8  tf_usage_bad.R:8 T/F usage check
#> 2 tf_usage_bad.R   11 tf_usage_bad.R:11 T/F usage check
#> 3 tf_usage_bad.R   15 tf_usage_bad.R:15 T/F usage check
#> 4 tf_usage_bad.R   18 tf_usage_bad.R:18 T/F usage check
#> 5 tf_usage_bad.R   22 tf_usage_bad.R:22 T/F usage check
#> 6 tf_usage_bad.R   25 tf_usage_bad.R:25 T/F usage check
#> 7 tf_usage_bad.R   29 tf_usage_bad.R:29 T/F usage check