makeGScoresPackage: Building genomic gscores packages
In rcastelo/GenomicScores: Infrastructure to work with genomewide position-specific scores

View source: R/makeGScoresPackage.R

makeGScoresPackage

R Documentation

Building genomic gscores packages

Description

Build a genomic gscores packages from a GScores object.

Usage

makeGScoresPackage(gsco, version, maintainer, author,
                   destDir=".", license="Artistic-2.0")

Arguments

`gsco`	`GScores`. The `GScores` object from which the package will be created.
`version`	`Character`. Version of the package.
`maintainer`	`Character`. Maintainer of the package, including email.
`author`	`Character`. Author of the package.
`destDir`	`Character`. The path to the directory where the package will be created.
`license`	`Character`. The license of the package.

Details

This function allows one to create an R package from a GScores object. This may be useful if one wants to have a tar-ball package version of genomic scores available only through the AnnotationHub; see the vignette.

Value

It returns invisibily the package directory.

Author(s)

R. Castelo

References

Puigdevall, P. and Castelo, R. GenomicScores: seamless access to genomewide position-specific scores from R and Bioconductor. Bioinformatics, 18:3208-3210, 2018.

Examples


## accessing genomic scores from AnnotationHub resources
## and building a package from them
## Not run: 
availableGScores()
gsco <- getGScores("fitCons.UCSC.hg19")
makeGScoresPackage(gsco, version="1.0", maintainer="me <me@example.com>", author="me")

## End(Not run)

rcastelo/GenomicScores documentation built on May 5, 2024, 11:38 a.m.