rnb.save.annotation: rnb.save.annotation

Description Usage Arguments Details Value Author(s) See Also

View source: R/annotations.R

Description

Saves the specified region annotation table and its accompanying data structures to a binary file.

Usage

1
rnb.save.annotation(fname, type, assembly = "hg19")

Arguments

fname

One-element character vector giving the name of the file to contain the annotation data. If this file already exists, it will be overwritten.

type

One-element character vector giving the name of the region annotation.

assembly

Genome assembly of interest. See rnb.get.assemblies for the list of supported genomes.

Details

This function is used in combination with rnb.load.annotation to enable fast reloading of custom region annotations. If can also be used to save a build-in region annotation (e.g. before overwriting it) but not site or control probe annotations.

Value

TRUE, invisibly.

Author(s)

Yassen Assenov

See Also

rnb.load.annotation for loading a saved annotation


RnBeads documentation built on March 3, 2021, 2 a.m.