Skip to content

Style Guide

Dylan Beaudette edited this page Jun 15, 2020 · 12 revisions

Overview

Other People's Code

Dependencies

Code

Function Design

Aspirations for now:

  • optimize for intuition ("estimate a thing") and accurate code-completion (estimate...) vs. pure style adherance
  • relatively "uniform" syntax that reflects a cohesive, well-thought out package
  • minimal number of keystrokes, while still providing essential context as to what a function does
  • function names should include verbs -- they "do" something
  • arguments (names) that refer to the same data for similar functions should do similar things

Documentation

Testing

Commiting Code

CRAN Release Cycle

Clone this wiki locally