Package index • pkgaudit

Scanning a package

audit_package(): Audit an R source package
audit_tarball(): Audit an R source package tarball

Reading a result

format(<pkgaudit>) print(<pkgaudit>): Format or print a pkgaudit result
summary(<pkgaudit>) print(<summary.pkgaudit>): Summarize a pkgaudit result

Carrying a result to another tool

emit_sarif(): Render a scan as SARIF
export_unscanned(): Export the code pkgaudit could not read

Rules

load_rules(): Load security rules from the pkgaudit rules database
rules_version(): Return the current rules database version

Provenance

hash_manifest(): Compute a manifest hash for a directory
validate_tar(): Validate a source package tarball before extraction

Extending pkgaudit

See CONTRIBUTING.md.

extract_segments(): Read one source file into the code segments it contains
analyze_segment(): Find code contexts, patterns and matches in one segment
new_segment(): Build one code segment
new_findings(): Build the return value of an analyze_segment() method