Description
Package Development Documentation and Namespace Management.
Description
Manage package documentation and namespaces from the command line. Programmatically attach namespaces in R and Rmd script, populates 'Roxygen2' skeletons with information scraped from within functions and populate the Imports field of the DESCRIPTION file.
README.md
Tests and Coverage
26 March, 2022 07:30:41
This output is created by covrpage.
Coverage
Coverage summary is created using the covr package.
| Object | Coverage (%) |
|---|---|
| sinew | 21.62 |
| R/create_yml.R | 0.00 |
| R/get_oxy.R | 0.00 |
| R/interOxyAddIn.R | 0.00 |
| R/ls_param.R | 0.00 |
| R/makeDictionary.R | 0.00 |
| R/makeOxyFile.R | 0.00 |
| R/makeOxygen.R | 0.00 |
| R/moga.R | 0.00 |
| R/opts_complete.R | 0.00 |
| R/oxygenAddin.R | 0.00 |
| R/pretty_addin_utils.R | 0.00 |
| R/pretty_addin.R | 0.00 |
| R/pretty_rmd.R | 0.00 |
| R/pretty_sinew.R | 0.00 |
| R/rm_oxylines.R | 0.00 |
| R/rmOxygen.R | 0.00 |
| R/something.R | 0.00 |
| R/untangle_examples.R | 0.00 |
| R/opts.R | 5.88 |
| R/zzz.R | 11.11 |
| R/pretty_namespace.R | 43.48 |
| R/pretty_utils.R | 46.08 |
| R/make_seealso.R | 58.82 |
| R/makeImport.R | 61.02 |
| R/tabular.R | 88.89 |
| R/prettify.R | 94.83 |
| R/untangle.R | 96.67 |
| R/check_attach.R | 100.00 |
Unit Tests
Unit Test summary is created using the testthat package.
| file | n | time | error | failed | skipped | warning |
|---|---|---|---|---|---|---|
| test-check_attach.R | 2 | 0.099 | 0 | 0 | 0 | 0 |
| test-pretty.R | 15 | 1.806 | 0 | 0 | 0 | 0 |
| test-rm.R | 4 | 0.082 | 0 | 0 | 0 | 0 |
| test-seealso.R | 2 | 0.002 | 0 | 0 | 0 | 0 |
| test-tabular.R | 3 | 0.124 | 0 | 0 | 0 | 0 |
| test-untangle.R | 6 | 0.013 | 0 | 0 | 0 | 0 |
Show Detailed Test Results
| file | context | test | status | n | time |
|---|---|---|---|---|---|
| test-check_attach.R | check_attach | test check attach: already loaded | PASS | 1 | 0.093 |
| test-check_attach.R | check_attach | test check attach: not already loaded | PASS | 1 | 0.006 |
| test-pretty.R | pretty | switches: force | PASS | 2 | 1.144 |
| test-pretty.R | pretty | switches: ignore | PASS | 1 | 0.181 |
| test-pretty.R | pretty | setup files: length | PASS | 1 | 0.003 |
| test-pretty.R | pretty | setup files: class | PASS | 1 | 0.185 |
| test-pretty.R | pretty | setup files: names | PASS | 1 | 0.002 |
| test-pretty.R | pretty | setup file: length | PASS | 1 | 0.002 |
| test-pretty.R | pretty | setup file: class | PASS | 1 | 0.009 |
| test-pretty.R | pretty | setup file: names | PASS | 1 | 0.002 |
| test-pretty.R | pretty | setup text: length | PASS | 1 | 0.001 |
| test-pretty.R | pretty | setup text: class | PASS | 1 | 0.007 |
| test-pretty.R | pretty | setup text: names | PASS | 1 | 0.002 |
| test-pretty.R | pretty | full text: txt | PASS | 2 | 0.100 |
| test-pretty.R | pretty | full file: file | PASS | 1 | 0.168 |
| test-rm.R | remove oxygen | rm valid actions: no show file | PASS | 1 | 0.058 |
| test-rm.R | remove oxygen | rm valid actions: show file | PASS | 1 | 0.004 |
| test-rm.R | remove oxygen | rm invalid actions: extension | PASS | 1 | 0.013 |
| test-rm.R | remove oxygen | rm invalid actions: path | PASS | 1 | 0.007 |
| test-seealso.R | make seealso | cutoff: less than cutoff | PASS | 1 | 0.001 |
| test-seealso.R | make seealso | no cutoff: no elements | PASS | 1 | 0.001 |
| test-tabular.R | tabular | convert dataframe to tabular header: length | PASS | 1 | 0.002 |
| test-tabular.R | tabular | convert dataframe to tabular header: class | PASS | 1 | 0.120 |
| test-tabular.R | tabular | convert dataframe to tabular no header: length | PASS | 1 | 0.002 |
| test-untangle.R | untangle | parent functions: find the parents | PASS | 1 | 0.002 |
| test-untangle.R | untangle | parent functions: parent indicies | PASS | 1 | 0.002 |
| test-untangle.R | untangle | untangle inputs: empty | PASS | 1 | 0.005 |
| test-untangle.R | untangle | untangle inputs: text functions | PASS | 1 | 0.002 |
| test-untangle.R | untangle | untangle inputs: text body | PASS | 1 | 0.001 |
| test-untangle.R | untangle | untangle inputs: file | PASS | 1 | 0.001 |
Session Info
| Field | Value |
|---|---|
| Version | R version 4.1.0 (2021-05-18) |
| Platform | x86_64-apple-darwin17.0 (64-bit) |
| Running | macOS Big Sur 11.6 |
| Language | en_US |
| Timezone | America/New_York |
| Package | Version |
|---|---|
| testthat | 3.1.2 |
| covr | 3.5.1 |
| covrpage | 0.1 |