makeOrgPackageFromNCBI {AnnotationDbi}R Documentation

Making an organism package from annotations available from NCBI.

Description

The makeOrgPackageFromNCBI function allows the user to make an organism package from NCBI annotations available from the NCBI.

Usage


  makeOrgPackageFromNCBI(
    version=,
    maintainer,
    author,
    outputDir=".",
    tax_id,
    genus,
    species)

Arguments

version

What is the version number for this package?

maintainer

Who is the package maintainer? (must include email to be valid)

author

Who is the creator of this package?

outputDir

A path where the package source should be assembled.

tax_id

The Taxonomy ID that represents your organism. (NCBI has a nice online browser for finding the one you need)

genus

Single string indicating the genus.

species

Single string indicating the species.

Value

Nothing returned to the R session. Just creates an organism annotation package.

Author(s)

M. Carlson

Examples


## Not run: 
## Makes an organism package for Zebra Finch from NCBI:

makeOrgPackageFromNCBI(version = "0.1",
                       author = "Some One <so@someplace.org>",
                       maintainer = "Some One <so@someplace.org>",
                       outputDir = ".",
                       tax_id = "59729",
                       genus = "Taeniopygia",
                       species = "guttata")


## End(Not run)


[Package AnnotationDbi version 1.16.0 Index]