test_ggfastqc: Run a set of tests

Description Usage Arguments Details Value See Also Examples

Description

Runs a set of tests to check if ggfastqc is working correctly.

Usage

1
test_ggfastqc(verbose = FALSE, pkg = "pkg", silent = FALSE)

Arguments

verbose

If TRUE sets ggfastqc_verbose to TRUE for the duration of the tests.

pkg

Root directory name under which all package content (ex: DESCRIPTION, src/, R/, inst/ etc..) resides.

silent

Logical, default FALSE. When TRUE it will not raise error on in case of test fails.

Details

Runs a series of tests. These can be used to see features and examples of usage, too. Running test_ggfastqc will tell you the full location of the test file(s) to open.

Value

When silent equals to TRUE it will return TRUE if all tests were successful. FALSE otherwise. If silent equals to FALSE it will return TRUE if all tests were successful. Error otherwise.

See Also

fastqc, plot_gc_stats plot_dup_stats

Examples

1
2
3
4
## Not run: 
ggfastqc:::test_ggfastqc()

## End(Not run)

openanalytics/ggfastqc documentation built on May 24, 2019, 2:27 p.m.