qc: Quality Check

In gfcm/gfcmSTAR: Tools to Work with GFCM Stock Assessment Results (STAR)

Description

Run all quality checks on one or more Excel STAR templates.

Usage

qc(x, short = TRUE, stop = TRUE, quiet = FALSE)

Arguments

x	filename of an Excel STAR template or a directory containing Excel STAR templates.
short	whether to show filenames in a short basename format.
stop	whether to stop if any test fails.
quiet	whether to suppress messages.

Details

If x is a directory, stop is set to FALSE unless the user passes an explicit stop = TRUE.

Value

String indicating which test did not succeed, or a vector of strings if x is a directory. A value of "" means all tests succeeded for that file.

Note

A generic script to quality check many STAR templates is covered in the 'Script' section of the gfcmSTAR-package help page.

See Also

The checks are run in the following order:

qc.exists checks if file exists.

qc.xlsx checks if file extension is ‘xlsx’.

qc.star checks if file is a STAR template.

qc.vpa checks if VPA_Model is Yes or No.

qc.ts.names checks if time series column names are intact.

qc.ts.numbers checks if time series are numbers and not strings.

report reports which files were successfully imported.

gfcmSTAR-package gives an overview of the package.

Examples

## Not run: 

# Filename
qc("STAR_2019_HKE_5.xlsx")

# Directory
ok <- qc("working_group")
ok[!ok]

## End(Not run)

gfcm/gfcmSTAR documentation built on Feb. 5, 2022, 2:14 p.m.