Note: this document is work in progress! Please send comments / suggestions using disqus, by posting issues or via pull requests. The file generating this page is there.

This document provides guidelines for package review which are meant to promote clearer, robust, maintainable, and well-documented code. It borrows largely from the rOpenSci onboarding guidelines and from this post on the RECON forum. See list of contributors for more information on people who shaped this.

Package review guidelines

• run goodpractice to detect possible issues.

• go through the rOpenSci checklist

Credits

Besides the rOpenSci whose guidelines we largely adopted, the following people contributed to these guidelines; in alphabetic order:

• Gabor Csardi
• Rich Fitzjohn
• Thibaut Jombart
• Zhian N. Kamvar
• Noam Ross