biomartr (version 0.0.1)

download_database: Download a Database to Your Local Hard Drive

Description

This function allows you to download a database selected by listDatabases to your local hard drive.

Usage

download_database(name, db_format = "blastdb", path = "DB")

Arguments

name

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

db_format

a character string specifying database format, e.g. db_format = "blastdb".

path

a character string specifying the location (a folder) in which the corresponding database shall be stored. Default is path = "DB".

Details

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

Examples

# search for available NCBI nr databases
  listDatabases(db_name = "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(name = "nr.27.tar.gz", db_format = "blastdb")