externalize: create a package with a decomposed smlSet instance from a...

Description Usage Arguments Details Value Note Author(s) Examples

View source: R/externalize.R

Description

create a package with a decomposed smlSet instance from a unified smlSet instance, to reduce memory footprints

Usage

1
2
3
4
5
externalize(smlSet, packname, 
   author = "Replace Me <auth@a.b.com>", 
   maintainer = "Replace Me <repl@a.b.com>")

allsnps(packname)

Arguments

smlSet

an smlSet instance to be regarded as a source or template for a package that can be used with greater efficiency of access to genotype contents

packname

name of the package to be generated

author

string to be used in DESCRIPTION file of generated package

maintainer

string to be used in DESCRIPTION file of generated package

Details

The genotype content of the input smlSet is separated into separate RDA files in the inst/parts folder of the package to be generated. The ExpressionSet element of the input smlSet is stored as object ex in file eset.rda in the data folder of the package to be generated.

Value

creates folder structure and metadata for an installable R package

Note

allsnps() gives the list of vectors of snpnames in use in the package

Author(s)

VJ Carey <stvjc@channing.harvard.edu>

Examples

1
2
3
4
5
6
7
8
 ## Not run: 
 setwd(tempdir())
 sms = getSS("GGtools", c("20", "21"))
 externalize(sms, "demopack")
 dir()
 dir("demopack")
 
## End(Not run)

GGBase documentation built on Nov. 8, 2020, 5:45 p.m.