Skip to content

Commit

Permalink
docs: first draft of design principles.
Browse files Browse the repository at this point in the history
Closes #36
  • Loading branch information
lwjohnst86 committed Feb 26, 2024
1 parent 66c5cec commit 46ec7a7
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions vignettes/design.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,17 @@ knitr::opts_chunk$set(
comment = "#>"
)
```

## Principles

These are the guiding principles for this package:

1. Functionality is as agnostic to data format as possible (e.g. can be
used with SQL or Arrow connections, in a data.table format, or as a
data.frame).
2. Functions have consistent inputs and outputs (e.g. inputs and
outputs are the same, regardless of specific conditions).
3. Functions have predictable outputs based on inputs (e.g. if an input
is a data frame, the output is a data frame).
4. Functions have consistent naming based on their action.
5. Functions have limited additional arguments.

0 comments on commit 46ec7a7

Please sign in to comment.