download.database: Download a NCBI Database to Your Local Hard Drive

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

View source: R/download_database.R

Description

This function allows users to download a database selected by listDatabases to their local hard drive.

Usage

1
download.database(db, path = "database")

Arguments

db

a character string specifying the database that shall be downloaded (selected from listDatabases).

path

a character string specifying the location (a folder) in which the corresponding database shall be stored. Default is path = "database". In case this folder does not exist yet, it will be created.

Details

This function downloads large databases to your hard drive. For this purpose a folder named database (default) is created and the correspondning database then stored in this folder.

Value

File path to the downloaded database file.

Author(s)

Hajk-Georg Drost

See Also

download.database.all, listDatabases

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
  # search for available NCBI nr databases
  listNCBIDatabases(db = "nr")
  # select NCBI nr version 27 =  "nr.27.tar.gz"
  # and download it to your hard drive
  # -> please note that large databases take some time for download!
  download.database(db = "nr.27.tar.gz")

## End(Not run)

biomartr documentation built on July 2, 2018, 1:02 a.m.