Contribute Packages to Bioconductor
Switch branches/tags
Nothing to show
Clone or download

README.md

Table of Contents

Contributing a Bioconductor Package

This repository is used to contribute new packages to the Bioconductor project for the analysis and comprehension of high-throughput genomic data. Please

By using this service, please note that:

  • Your package code will be visible to the general public, where anyone can see it.

  • The build reports and comments during the review process are public.

  • Any GitHub user may add comments to the package review.

  • You are submitting a package for inclusion in Bioconductor; the build service we provide is meant only for individuals submitting Bioconductor packages.

Starting the Submission Process

To submit a package to Bioconductor:

  1. Create your own GitHub repository, containing source code structured as an R package. The source code must be in a default 'master' branch of your GitHub repository.

  2. Add SSH public key(s) to your GitHub account. The SSH key pair will be used after package acceptance for updating the Bioconductor git repository.

  3. Open a new issue. Complete the issue by adding the link to your repository, and confirming that you understand the review process, package guidelines, and maintainer responsibilities. Provide the name of your package as the 'Title' of the issue.

  4. Add a webhook to your repository. The webhook means that any commit to the default 'master' branch automatically triggers a new package build.

What to Expect

  • A new package is initially labeled as '1. awaiting moderation'. A Bioconductor team member will take a very brief look at your package, to ensure that it is intended for Bioconductor. Appropriate packages will be re-labelled '2. review in progress'.

  • The package will be submitted to the Bioconductor build system. The system will check out your package from GitHub. It will then run R CMD build to create a 'tarball' of your source code, vignettes, and man pages. It will run R CMD check on the tarball, to ensure that the package conforms to standard R programming best practices. Finally, the build system will run R CMD BiocCheck to ensure that the package conforms to Bioconductor BiocCheck standards. The system will perform these steps using the 'devel' version of Bioconductor, on three platforms (Linux, Mac OS X, and Windows). After these steps are complete, a link to a build report will be appended to the new package issue. Avoid surprises by running these checks on your own computer, under the 'devel' version of Bioconductor, before submitting your package.

  • If the build report indicates problems, modify your package and commit changes to the default branch of your GitHub repository. If there are problems that you do not understand, seek help on the bioc-devel mailing list.

  • To trigger a new build, include a version bump in your commit, e.g., from Version: 0.99.0 to Version: 0.99.1.

  • Once your package builds and checks without errors or (avoidable) warnings, a Bioconductor team member will provide a technical review of your package. Other Bioconductor developers and users with domain expertise are encouraged to provide additional community commentary. Reviewers will add comments to the issue you created.

  • Respond to the issues raised by the reviewers. You must respond to the primary reviewer, and are strongly encouraged to consider community commentary. Typically your response will involve code modifications; commit these to the default branch of your GitHub repository to trigger subsequent builds. When you have addressed all concerns, add a comment to the issue created in step 2 to explain your response.

  • The reviewer will assess your responses, perhaps suggesting further modifications or clarification. The reviewer will then accept your package for inclusion in Bioconductor, or decline it. The label '2. review in progress' will be replaced by '3a. accepted' or '3b. declined'.

  • If your package is accepted, it will be added to Bioconductor's Subversion source control repository and to the nightly 'devel' builds. All packages in the 'devel' branch of the repository are 'released' to the user community once every six months, in approximately April and October.

  • Once the review process is complete, the issue you created will be closed. All updates to your package will be through the Bioconductor Subversion repository (optionally, using GitHub).

Adding a Web Hook

To add a web hook:

  1. Go to your repository page on GitHub. The link to it will look something like this:

     https://github.com/yourusername/yourpackagename
    

    Of course, yourusername and yourpackagename will be different.

  2. Click on Settings, which is currently located towards the top, on the right-hand side of the page.

  3. In the left hand Options section, click on Webhooks & services.

  4. Click on Add webhook.

  5. Paste the following URL into the Payload URL box, leaving the other settings alone:

     http://issues.bioconductor.org
    
  6. Confirm that the Content type drop-down menu has application/json selected.

  7. Click Add webhook.

  8. The page will be updated to include a link to the web hook. Click on the link. A 'Recent Deliveries' area should contain a single request. Click on the Request and view the "Response" tab. There should be a green 200 response code, with body ping received, Bioconductor/Contributions webhook ok.

Subsequent pushes to the default master branch of your repository will now trigger builds (only if the package version has been bumped), and the build reports will be posted to the issue you created in this repository. Note that pushes to branches that are not master, or non-default branches, are ignored.

Submitting Related Packages

Sometimes it is appropriate to contribute more than one package at a time. The most common case is when a software package has a companion experiment data package used for illustrative purposes in the vignette. Remember to avoid circular dependencies between packages.

  1. Start by submitting the package that can be installed without a dependency on any of the other packages you are submitting (this is usually the experiment data package). Do this by creating a new issue as described above.

  2. Continue working with this package until it builds and checks without error on any platform.

  3. Submit additional packages to the same issue. Do this by posting a comment containing a line like:

     AdditionalPackage: https://github.com/username/repositoryname
    

    Include only one AdditionalPackage line per comment. Wait until this related package builds before submitting further related packages.

  4. The AdditionalPackage comment must be posted by the same GitHub user who created the issue. Also, the initial package submitted in the issue must have completed the 'moderation' step. If these conditions are not met, the additional package will not build.

  5. Add a webhook for each additional package, so that any changes (accompanied by a version bump) trigger a new build.

Additional Actions

To change the repository of your package during the review process:

  1. Edit the first comment in the issue associated with your package. Change the Repository: link to point to your new repository.
  2. Add a webhook to the new repository (and remove the corresponding web hook from the old repository).
  3. Post a comment in your issue, including @mtmorgan, indicating that you have changed the repository.
  4. Once the comment is acknowledged, bump the package version in the new repository to trigger a new build.

To remove an AdditionalPackage: dependency, e.g., because you have identified AnnnotationHub or other resources that make your additional package unnecessary:

  1. Delete or edit all comments with an AdditionalPackage: tag.

To debug package commits that don't trigger a response on the corresponding issue:

  1. Verify that the web hook is in place.

  2. Review 'Recent Deliveries', especially those marked as failures (red triangle with exclamation mark). Click on the checksum, look at the 'Response' body.

  3. If the response body says 'Failed to parse JSON', verify that the web hook (in your repository, 'Settings', 'Webhooks', 'Edit' the web hook you've added) has 'Content type:' equal to application/json.

  4. After debugging, click the 'Redeliver' button.

Resources

The following pages contain more information about package submission.

If you have a question not answered above, please ask on the bioc-devel mailing list.