Function naming philosophy
Function names follow a strict verb convention based on what the function primarily does:
init_()— one-time scaffolding of a workspace or environment. Runs once, creates a persistent structure, gets out of the way. Example:init_project().create_()— produces a specific file or artifact the user will author or edit directly. May be called multiple times in the same project. Example:create_qmd().generate_()— derives or assembles an output from inputs that already exist. A transformation is happening. Example:generate_dockerfile(),generate_kb_xml().read_()— loads data into the R session. Nothing is written to disk. Example:read_clean_csv().write_()— persists data or results from the session to disk. The complement toread_(). Example:write_by_group().
File naming convention
- R source files use dashes:
create-qmd.R,write-by-group.R - R functions and objects use underscores:
create_qmd(),write_by_group()