yonicd / covrpage

Create a summary readme for the testthat subdirectory to communicate with potential users
https://yonicd.github.io/covrpage/
Other
52 stars 7 forks source link

group references in pkgdown site #29

Closed yonicd closed 6 years ago

yonicd commented 6 years ago

grouping of functions in the references for pkgdown

Function Description Group
coverage_skip() Run covr with failing tests Testing Utility
covr_log() Log of code coverage Postprocess
covr_summary() Summary outputs for covr object Output Manipulation
covrpage() Render covrpage Invoking
covrpage_ci() covrpage for travis Invoking
covrpage_log() Log of covrpage outputs Postprocess
make_badge() Create covrpage Badge Setup
map_test() Map a single test file Testing Utility
map_testthat() Hierarchy structure of testthat tests Testing Utility
%>% Re-export magrittr pipe operators General Utility
sinfo() importFrom utils sessionInfo packageVersion General Utility
tencrypt() Encrypt Travis environment variables Setup
testthat_summary() Summary outputs for testthat object Output Manipulation
use_covrpage() Add covrpage to Travis CI for a git directory Setup
use_covrpage_vignette() Create a vignette for covrpage Setup
yonicd commented 6 years ago

restructured on https://github.com/yonicd/covrpage/commit/818c64b4bf37708125dc2ae817d6d90096d9b1ae

maelle commented 6 years ago

Should this be closed?

Any interest in my re-creating the grouping using concepts with roxygen2 so that the functions might be "grouped" in the local docs as well?

yonicd commented 6 years ago

concepts added https://github.com/yonicd/covrpage/commit/d7bd8b54c3b5ffbf7097f9ff9060319d5af14231