qc.ts.names: Time Series Names

Description Usage Arguments Value Note See Also Examples

View source: R/qc.ts.names.R

Description

Assert that a STAR template's time series column names are intact.

Usage

1
qc.ts.names(file, short = TRUE, stop = TRUE, quiet = FALSE)

Arguments

file

filename of an Excel STAR template.

short

whether to show the filename in a short basename format.

stop

whether to stop if test fails.

quiet

whether to suppress messages.

Value

TRUE if test succeeds, otherwise an error message (if stop = TRUE) or FALSE and a warning message (if stop = FALSE).

Note

This function compares the column names found in the STAR template sheet containing the time series against the expected column names. The expected column names are those defined inside the set.classes function.

See Also

qc runs all qc.* tests.

gfcmSTAR-package gives an overview of the package.

Examples

1
2
3
4
## Not run: 
qc.ts.names("STAR_2019_HKE_5.xlsx")

## End(Not run)

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