Package Submission

• Introduction
• Checklist
• Additional Support
• Contact Information

Introduction

Users are welcome to contribute new packages to Bioconductor. Packages must meet a checklist of standards of functionality, documentation, and interoperability. See Contact information to obtain instructions for submitting new packages.

Authors receive initial feedback in 1 to 3 weeks. Packages will be checked for adherence to the Bioconductor package guidelines and the checklist below by a member of Bioconductor team. Package developers should consult the full Bioconductor Package Guidelines. Submission implies commitment to package maintenance across multiple release cycles.

Checklist

Packages must satisfy the following checklist:

• Pass R CMD build and R CMD check on all supported platforms (Windows, Macintosh, Linux) with no errors or warnings, using a recent R-devel. The result of R CMD build must be less than 2MB; R CMD check must complete within 5 minutes.
• Contain a DESCRIPTION file with valid contact information, an informative title and description, correct license specification, appropriate biocViews terms, valid version number.
• Contain a NAMESPACE that imports all symbols used in the package, and exports just those symbols the package author identifies as appropriate. Use of a NAMESPACE implies that appropriate packages are mentioned in the Imports: field of the DESCRIPTION file.
• Contain a Sweave-style vignette that illustrates the major uses of the package. The vignette must be evaluated during package installation; a static vignette (e.g., PDF) is not acceptable.
• Contain complete help pages. This includes accurate description of function parameter and return values, and meaningful examples.
• Make use of appropriate existing packages (e.g., biomaRt, AnnotationDbi, Biostrings) and classes (e.g., ExpressionSet, AnnotatedDataFrame, RangedData, Rle, DNAStringSet) to avoid duplication of functionality available in other Bioconductor packages.
• Contain no extraneous files (e.g., '.DS_Store', '.project', '.svn', etc.), files with invalid names (e.g., differing only in case), or code that cannot be distributed under the license specified by the author.
• Packages must not already be available on CRAN.

Packages should also conform to the following:

• Use S4 classes and methods.
• Include an inst/NEWS file for providing users with information on package updates.

[ Back to top ]

Additional Support

We are eager to enhance the quality and interoperability of Bioconductor software and will provide additional support when requested by package developers. Example areas of assistance include use of appropriate S4 structures, specific guidance on efficient implementation, guidance on code structure, and critical assessment of package documentation and structure. Use the bioc-devel mailing list or the Contact information below to obtain additional support.

[ Back to top ]

Contact Information

To submit a package or obtain additional support, contact Marc Carlson (email: mcarlson NEAR fhcrc POINT org)

[ Back to top ]