biomartr (version 0.9.0)

getGTF: Genome Annotation Retrieval (GTF)

Description

Main retrieval function for GTF files of an organism of interest. By specifying the scientific name of an organism of interest the corresponding GTF file storing the annotation for the organism of interest can be downloaded and stored locally. GTF files can be retrieved from several databases.

Usage

getGTF(db = "ensembl", organism, path = file.path("ensembl",
  "annotation"))

Arguments

db

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

• db = "ensembl"

organism

a character string specifying the scientific name of the organism of interest, e.g. organism = "Homo sapiens".

path

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

Value

File path to downloaded annotation file.

Details

Internally this function loads the the overview.txt file from ENSEMBL: and creates a directory 'ensembl/annotation' to store the genome of interest as fasta file for future processing. In case the corresponding fasta file already exists within the 'ensembl/annotation' folder and is accessible within the workspace, no download process will be performed.

See Also

getProteome, getCDS, getGenome, getRNA, getRepeatMasker, getAssemblyStats, meta.retrieval, getGFF

Examples

# NOT RUN {
# download the annotation of Arabidopsis thaliana from refseq
# and store the corresponding genome file in 'ensembl/annotation'
getGTF( db       = "ensembl", 
               organism = "Homo sapiens", 
               path = file.path("ensembl","annotation"))

# }
# NOT RUN {
# }