epiforecasts / ringbp

Simulate infectious disease transmission with contact tracing
http://epiforecasts.io/ringbp/
Other
15 stars 10 forks source link

Functions Problems #29

Open pearsonca opened 4 years ago

pearsonca commented 4 years ago

In general, the function arguments are poorly named.

The are often too long.

They have similar prefixes (e.g., num.initial.cases and num.initial.clusters), which can present problems with R's ability to partially match named arguments.

They don't lean on the nomenclature established by the language ecosystem (e.g., incfn could be rIncubation to leverage people's familiarity with runif, rexp, etc.).

There are several functions with lots of arguments. Almost always an indication of doing to much in a function, and thus needing to change steps and how data flows between them.