HomoloGeneBuilder_DB: Build Data Packages for Homolog Protein Group

Description Usage Arguments Details Value Author(s) Examples

View source: R/HomoloGeneBuilder_DB.R

Description

This function creates a data package of homologs among the annotated genes of several completely sequenced eukaryotic genomes from NCBI HomoloGene.

Usage

1
HomoloGeneBuilder_DB(prefix, pkgPath, version, author)

Arguments

prefix

the prefix of the name of the data package to be built. (e.g. "hsaSP"). The name of builded package is prefix+".db".

pkgPath

a character string for the full path of an existing directory where the built backage will be stored.

version

a character string for the version number.

author

a list with named elements "authors" containing a character vector of author names and "maintainer" containing the complete character string for the maintainer field, for example, "Jane Doe <jdoe@doe.com>".

Details

HomoloGeneBuilder_DB employes functions writeHomoloGeneData_DB to parse and write data. Only several completely sequenced eukaryotic genomes are involved: Homo sapiens, Pan troglodytes, Canis lupus familiaris, Bos taurus, Mus musculus, Rattus norvegicus, Gallus gallus, Danio rerio, Drosophila melanogaster, Anopheles gambiae, Caenorhabditis elegans, Schizosaccharomyces pombe, Saccharomyces cerevisiae, Kluyveromyces lactis, Eremothecium gossypii, Magnaporthe grisea, Neurospora crassa, Arabidopsis thaliana, Oryza sativa, Plasmodium falciparum.

Data files in the database will be automatically downloaded to the tmp directory, so enough space is needed for the data files. After downloading, files are parsed by perl, so perl must be installed. It may take a long time to parse database and build R package. Alternatively, we have produced diverse R packages by PAnnBuilder, and you can download appropriate package via http://www.biosino.org/PAnnBuilder.

Value

This function does not return any value.

Author(s)

Hong Li

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
# Set path, version and author for the package.
pkgPath <- tempdir()
version <- "1.0.0"
author <- list()
author[["authors"]] <- "Hong Li"
author[["maintainer"]] <- "Hong Li <sysptm@gmail.com>"

## It may take a long time to parse database and build R package.
# Build annotation data packages "homolog.db" for Homo sapiens proteomics gene 
# ontology.
if(interactive()){
    HomoloGeneBuilder_DB(prefix = "homolog", pkgPath, version, author)
}

PAnnBuilder documentation built on May 2, 2018, 4:07 a.m.