ic_qa: Automated QA form population

In IntegralEnvision/integral: Integral Consulting Public Package

Automated QA form population

Description

Scrape an .R or .Rmd file for QA tags, and populate the Integral QA sheet for scripted analyses.

To use, tag QA review items by adding QA comments throughout your script in the format:

⁠# QA: [your review comment or request]⁠

When you are ready to fill the excel QA sheet, run ic_qa() and choose the script you have added QA comments to.

Usage

ic_qa(filepath = "youfile.R")

Arguments

filepath

The file to QA. Can include either an absolute path or a relative path (including "~" home references). If omitted, a file selection dialog box will appear.

Function Process

The function will perform the following actions:

• Scrape the file for section headers and '# QA:' comment tags

• Assign unique ID's to QA tags in the code (the file will be modified) if they do not have one.

• Create a QA subdirectory and a QA excel workbook if one does not exist

• Add a code review spreadsheet for the file if one does not exist; update the spreadsheet for the file if one already exists

IntegralEnvision/integral documentation built on Nov. 4, 2024, 2 p.m.