biomartr (version 0.5.1)

meta.retrieval: Perform Meta-Genome Retieval

Description

Download genomes, proteomes, cds, gff, rna, or assembly stats files of all species within a kingdom of life.

Usage

meta.retrieval(kingdom, group = NULL, db = "refseq", type = "genome",
  combine = FALSE, path = NULL)

Arguments

kingdom

a character string specifying the kingdom of the organisms of interest, e.g. "archaea","bacteria", "fungi", "invertebrate", "plant", "protozoa", "vertebrate_mammalian", or "vertebrate_other". Available kingdoms can be retrieved with getKingdoms.

group

only species belonging to this subgroup will be downloaded. Groups can be retrieved with getGroups.

db

a character string specifying the database from which the genome shall be retrieved: db = "refseq", db = "genbank", db = "emsembl" or db = "ensemblgenomes".

type

type of sequences that shall be retrieved. Options are:

• type = "genome" : (for genome assembly retrieval; see also getGenome),
• type = "proteome" : (for proteome retrieval; see also getProteome),
• type = "CDS" : (for coding sequence retrieval; see also getCDS),
• type = "gff" : (for annotation file retrieval in gff format; see also getGFF),
• type = "gtf" : (for annotation file retrieval in gtf format (only for ensembl and ensemblgenomes); see also getGTF)
• type = "rna" : (for RNA file retrieval in fasta format; see also getRNA),
• type = "rm" : (for Repeat Masker output file retrieval; see also getRepeatMasker),
• type = "assemblystats" : (for genome assembly quality stats file retrieval; see also getAssemblyStats).

combine

just in case type = "assemblystats" is specified, shall assemby stats of individual species be imported and combined to a data.frame?

path

path to the folder in which downloaded genomes shall be stored. By default the kingdom name is used to name the output folder.

Value

a character vector storing the file paths of the retrieved files.

Details

This function aims to perform bulk retrieval of the genomes, proteomes, cds, etc. of species that belong to the same kingdom of life or to the same subgroup.

See Also

meta.retrieval.all

Examples

## Not run: ------------------------------------
# # get all available kingdoms for refseq
# getKingdoms(db = "refseq")
# # download all vertebrate genomes from refseq
# meta.retrieval(kingdom = "vertebrate_mammalian", 
#                db = "refseq", 
#                type = "genome")
# 
# # get all available kingdoms for genbank
# getKingdoms(db = "genbank")
# # download all vertebrate genomes from genbank
# meta.retrieval(kingdom = "vertebrate_mammalian", 
#                db = "genbank", 
#                type = "genome")
# 
# # get all available kingdoms for ensemblgenomes
# getKingdoms(db = "ensemblgenomes")
# # download all vertebrate genomes from ensemblgenomes
# meta.retrieval(kingdom = "vertebrate_mammalian", 
#                db = "ensemblgenomes", 
#                type = "genome")
# 
# # In case users do not wish to retrieve genomes from an entire kingdom, 
# # but rather from a subgoup (e.g. from species belonging to the 
# # Gammaproteobacteria class, a subgroup of the bacteria kingdom), 
# # they can use the following workflow"
# # First, users can again consult the getKingdoms() function to retrieve 
# # kingdom information.
# getKingdoms(db = "refseq")
# 
# # In this example, we will choose the bacteria kingdom. 
# # Now, the getGroups() function allows users to obtain available 
# # subgroups of the bacteria kingdom.
# getGroups(db = "refseq", kingdom = "bacteria")
# 
# # Now we choose the group Gammaproteobacteria and specify 
# # the group argument in the meta.retrieval() function
# meta.retrieval(kingdom = "bacteria", 
#    roup = "Gammaproteobacteria", 
#    db = "refseq", 
#    type = "genome")
## ---------------------------------------------