Download a NCBI Database to Your Local Hard Drive — download.database • biomartr
Description: This function allows users to download a database selected by listDatabases to their local hard drive.

# Download a NCBI Database to Your Local Hard Drive

Source: `R/download_database.R`
`download.database.Rd`

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

    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.

## Value

File path to the downloaded database file.

## 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.

## See also

`download.database.all`, `listDatabases`

## Author

Hajk-Georg Drost

## Examples

    if (FALSE) {
      # 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")
    }