-
Notifications
You must be signed in to change notification settings - Fork 9
Development philosophy
Caleb Easterly edited this page Feb 14, 2019
·
4 revisions
- 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 usingggtitle()
on the returned object.
- 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.
- However, we don't need to show everything in the package index. Using
- following the DRY principle, we can port comments across functions by using
#' @importParams <other function>
. This is used extensively with plotting functions, which all calladd_common_aes()