-
Notifications
You must be signed in to change notification settings - Fork 10
Function naming conventions
Ellis Hughes edited this page Feb 20, 2021
·
3 revisions
Exported {valtools} functions follow a prefix naming convention to group functions by activity and facilitate auto-complete, as recommended in the ROpenSci Packaging guide
-
vt_scrape_: scrape from .Rmd/.md files into R data objects for including in summary tables, e.g. NEWS, coverage matrices -
vt_kable_: convert R data objects intokableExtraorknitr_kablecode suitable for dropping into an RMD chunkasis -
vt_doc_: generate specification and test case coverage files for use withvt_scrape_ -
vt_shiny_: call a shiny app for interactive user acceptance testing -
vt_run_: run code for side effects e.g. execute test code. -
vt_use_: Create a new item, similar todevtools::use_testvt_use_specvt_use_test_casevt_use_test_codevt_use_validation_report
-
vt_use_validation- Create validation skeleton to contain validation items and artifacts -
vt_create_package- Wrapper fordevtools::create_packageandvt_use_validation