download.missing.maps: Download ID Maps For snipeR

Description Usage Arguments Details Value Author(s) See Also Examples

Description

snipeR requires several data files including the STRING network database and files to map between different ID types. This function will download any missing files to a local directory.

Usage

1
download.missing.maps(dbpath = "snipe_maps")

Arguments

dbpath

The path to the directory where the data files will be downloaded. Defaults to "snipe_maps"

Details

Several files must be downloaded for snipeR to work. If necessary, a new directory in dbpath will be created and files will be downloaded to there. If you have previously downloaded these files you may copy or symlink them to this location so you don't have to re-download them. This can save many hours of time, and we recommend it.

Because these files can be quite large, it can take several hours to finish downloading even on a fast connection. As a result, if download.missing.maps has to download several files it will require confirmation before it downloads or else it will exit the program. This will provide you the opportunity to copy or symlink pre-downloaded files to the dbpath (or point dbpath at an old download).

Note that this function will be called by snipe so access to it is mainly provided so that you can pre-cache the data files.

Value

Returns TRUE if everything succeeded.

Author(s)

David Nusinow dnusinow@partners.org

See Also

snipe, string.raw.to.sqlite, string.aliases.to.sqlite.

Examples

1
2
## Not run: download.missing.maps()
## Not run: download.missing.maps(dbpath = "~/string_maps")

dnusinow/snipeR documentation built on May 15, 2019, 9:40 a.m.