Summarize revision and QC history for a file or directory

Source: R/fileSummary.R

Generates a comprehensive summary of the revision and quality control (QC) history for a file. The function reports:

  • QC status (up to date, needs QC, or not assigned)

  • Presence in the QC log

  • Historical information about previous authors

  • Historical information about previous QC reviewers

fileSummary(.file)

Arguments

.file

File or directory path.

Details

The function prints a formatted summary to the console and invisibly returns the data for programmatic use. If a directory is supplied, each immediate file in that directory is summarized and a named list of results is returned. Non-existent files generate warnings and are skipped. Files not found in the repository history are also skipped.

QC status can be:

  • "QC up to date" - Latest revision has been QC'd

  • "Needs QC" - New changes need review

  • "Not assigned" - File not in QC system

Examples

if (FALSE) { # \dontrun{
# Analyze a single script file
fileSummary("script/data-assembly/study-101.R")

# Process all files in a directory
fileSummary("script/data-assembly")
} # }