getCDS: Coding Sequence Retrieval

Description Usage Arguments Value Author(s) See Also Examples

View source: R/getCDS.R

Description

Main retrieval function for coding sequences (CDS) of an organism of interest. By specifying the scientific name of an organism of interest the corresponding fasta-file storing the CDS information for the organism of interest can be downloaded and stored locally. CDS files can be retrieved from several databases.

Usage

1
2
getCDS(db = "refseq", organism, reference = TRUE,
  path = file.path("_ncbi_downloads", "CDS"))

Arguments

db

a character string specifying the database from which the genome shall be retrieved:

  • db = "refseq"

  • db = "genbank"

  • db = "ensembl"

  • db = "ensemblgenomes"

organism

there are three options to characterize an organism:

  • by scientific name: e.g. organism = "Homo sapiens"

  • by database specific accession identifier: e.g. organism = "GCF_000001405.37" (= NCBI RefSeq identifier for Homo sapiens)

  • by taxonomic identifier from NCBI Taxonomy: e.g. organism = "9606" (= taxid of Homo sapiens)

reference

a logical value indicating whether or not a genome shall be downloaded if it isn't marked in the database as either a reference genome or a representative genome.

path

a character string specifying the location (a folder) in which the corresponding CDS file shall be stored. Default is path = file.path("_ncbi_downloads","CDS").

Value

File path to downloaded CDS file.

Author(s)

Hajk-Georg Drost

See Also

getGenome, getProteome, getGFF, getRNA, meta.retrieval, read_cds

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## Not run: 
# download the genome of Arabidopsis thaliana from refseq
# and store the corresponding genome CDS file in '_ncbi_downloads/CDS'
file_path <- getCDS( db       = "refseq", 
             organism = "Arabidopsis thaliana", 
             path     = file.path("_ncbi_downloads","CDS"))

Ath_CDS <- read_cds(file_path, format = "fasta")


## End(Not run)

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