From 46ec7a7f427164e355e48a91fa79c80a28c668a0 Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Mon, 26 Feb 2024 13:39:17 +0100 Subject: [PATCH] docs: first draft of design principles. Closes #36 --- vignettes/design.Rmd | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/vignettes/design.Rmd b/vignettes/design.Rmd index a5488ea..7cd9ddb 100644 --- a/vignettes/design.Rmd +++ b/vignettes/design.Rmd @@ -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.