qc.star: STAR Template

Description Usage Arguments Value See Also Examples

View source: R/qc.star.R

Description

Assert that a file is a STAR template and contains a Metadata sheet.

Usage

1
qc.star(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).

See Also

qc runs all qc.* tests.

gfcmSTAR-package gives an overview of the package.

Examples

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

## End(Not run)

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