testdata: Generation of test data

Description Usage Arguments Details Value Examples

Description

For the purposes of examples and testing the package, tornadoplot includes some functions that make up some dummy data that isn't too large.

Usage

1
2
3
4
5
6
7
8
9

Arguments

pattern

A character(1) giving an initial part of a file name.

dir

A character(1) giving a directory name where to create the test file.

Details

The dummy_granges_data() and dummy_bigwig() generators make their data around the genomic ranges returned by dummy_features().

The dummy_bigwig() and dummy_tabix() files create files on your system. As their usage is intended as temporary files, don't forget to unlink() their paths and indices after they are no longer needed.

The dummy_tornado() makes a relatively small TornadoExperiment.

Value

The return values differ per function.

dummy_features

A GRanges object of length 2.

dummy_granges_data

A GRanges object of length 20.

dummy_bigwig

A BigWigFile object.

dummy_tabix

A TabixFile object with "A" and "B" in the 4th column.

dummy_tornado

A TornadoExperiment object with 2 samples, 4 features and 50 bins.

Examples

1
2
3
4
5
6
7
8
# All the functions run without arguments
feats <- dummy_features()
gr    <- dummy_granges_data()
bw    <- dummy_bigwig()
tbx   <- dummy_tabix()

# Don't forget to clean up the temporary files when you're done
unlink(c(path(bw), path(tbx), Rsamtools::index(tbx)))

teunbrand/tornadoplot documentation built on Dec. 23, 2021, 8:48 a.m.