Function naming conventions - phuse-org/valtools GitHub Wiki
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 matricesvt_kable_
: convert R data objects intokableExtra
orknitr_kable
code 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 testingvt_run_
: run code for side effects e.g. execute test code.vt_use_
: Create a new item, similar todevtools::use_test
vt_use_spec
vt_use_test_case
vt_use_test_code
vt_use_validation_report
vt_use_validation
- Create validation skeleton to contain validation items and artifactsvt_create_package
- Wrapper fordevtools::create_package
andvt_use_validation