Skip to content

Development philosophy

Caleb Easterly edited this page Feb 14, 2019 · 4 revisions

Visualization

  • all plots should support black-and-white modes
  • plot methods should not include anything that is easily modifiable by the user (i.e., they shouldn't include a title argument, in favor of someone using ggtitle() on the returned object.

Documentation

  • Use Roxygen to document every function.
    • However, we don't need to show everything in the package index. Using #' @keywords internal as a Roxygen comment means that the documentation file is still generated.
  • following the DRY principle, we can port comments across functions by using #' @importParams <other function>. This is used extensively with plotting functions, which all call add_common_aes()
Clone this wiki locally