Review all user facing functions
gothub opened this issue · comments
Any functions that will potentially be used interactively should be reviewed for:
- clear but brief parameter names
- consistency among all recordr functions
- consistency with commonly used major R packages
- ease of use
Use common naming for all function names, i.e. underlines vs camel case.
An article in the R journal discussed a survey of packages on CRAN which determined that lowerCamel case is the most
popular convention for naming functions, and dot-separated words is the most popular convention used for function arguments. The article also pointed out that there are several "guides" for naming conventions in R, but no clear consensus. The article is http://journal.r-project.org/archive/2012-2/RJournal_2012-2_Baaaath.pdf
The current list, with the most recent commit 145e980 is
- startRecord (recordr, tag)
- endRecord(recordr)
- record(recordr, file, tag, ...)
- deleteRuns(recordr, id, file, start, end, tag, error, seq, noop, quiet)
- listRuns(recordr, id, script, start, end, tag, error, seq, quiet, orderBy)
- viewRuns(recordr, id, file, start, end, tag, error, seq, orderBy, sections, verbose, page, quiet)
- publishRun((recordr, id, seq, assignDOI, update, quiet)
- getMetadata(recordr, id, seq, as)
- putMetadata(recordr, id, seq, metadata, asText)