-
Notifications
You must be signed in to change notification settings - Fork 1
Description
Checks for octolog (v0.1.1.9000)
git hash: fb7da5d7
- ✔️ Package name is available
- ✔️ has a 'CITATION' file.
- ✔️ has a 'codemeta.json' file.
- ✔️ has a 'contributing' file.
- ✔️ uses 'roxygen2'.
- ✔️ 'DESCRIPTION' has a URL field.
- ✔️ 'DESCRIPTION' has a BugReports field.
- ✔️ Package has at least one HTML vignette
- ✔️ All functions have examples.
- ✔️ Package has continuous integration checks.
- ✔️ Package coverage is 91.4%.
- ✔️ R CMD check found no errors.
- ✔️ R CMD check found no warnings.
Package License: MIT + file LICENSE
1. Statistical Properties
This package features some noteworthy statistical properties which may need to be clarified by a handling editor prior to progressing.
Details of statistical properties (click to open)
The package has:
- code in R (100% in 4 files) and
- 1 authors
- 1 vignette
- no internal data file
- 7 imported packages
- 20 exported functions (median 9 lines of code)
- 30 non-exported functions in R (median 9 lines of code)
Statistical properties of package structure as distributional percentiles in relation to all current CRAN packages
The following terminology is used:
loc= "Lines of Code"fn= "function"exp/not_exp= exported / not exported
The final measure (fn_call_network_size) is the total number of calls between functions (in R), or more abstract relationships between code objects in other languages. Values are flagged as "noteworthy" when they lie in the upper or lower 5th percentile.
| measure | value | percentile | noteworthy |
|---|---|---|---|
| files_R | 4 | 28.3 | |
| files_vignettes | 1 | 68.4 | |
| files_tests | 4 | 79.0 | |
| loc_R | 269 | 29.7 | |
| loc_vignettes | 26 | 3.4 | TRUE |
| loc_tests | 185 | 53.1 | |
| num_vignettes | 1 | 64.8 | |
| n_fns_r | 50 | 56.6 | |
| n_fns_r_exported | 20 | 67.4 | |
| n_fns_r_not_exported | 30 | 52.8 | |
| n_fns_per_file_r | 9 | 84.2 | |
| num_params_per_fn | 2 | 10.4 | |
| loc_per_fn_r | 9 | 24.3 | |
| loc_per_fn_r_exp | 9 | 19.2 | |
| loc_per_fn_r_not_exp | 10 | 30.7 | |
| rel_whitespace_R | 25 | 41.3 | |
| rel_whitespace_vignettes | 81 | 14.2 | |
| rel_whitespace_tests | 22 | 51.4 | |
| doclines_per_fn_exp | 26 | 25.0 | |
| doclines_per_fn_not_exp | 0 | 0.0 | TRUE |
| fn_call_network_size | 39 | 61.0 |
1a. Network visualisation
An interactive visualisation of calls between objects in the package has been uploaded as a workflow artefact. To view it, click on results from the latest 'pkgcheck' action, scroll to the bottom, and click on the 'visual-network' artefact.
2. goodpractice and other checks
Details of goodpractice and other checks (click to open)
3a. Continuous Integration Badges
GitHub Workflow Results
| name | conclusion | sha | date |
|---|---|---|---|
| Octolog example workflow | success | fb7da5 | 2022-02-13 |
| pages build and deployment | success | f9c21f | 2022-02-13 |
| pkgcheck | fb7da5 | 2022-02-13 | |
| pkgdown | success | fb7da5 | 2022-02-13 |
| R-CMD-check | fb7da5 | 2022-02-13 | |
| test-coverage | success | fb7da5 | 2022-02-13 |
3b. goodpractice results
R CMD check with rcmdcheck
rcmdcheck found no errors, warnings, or notes
Test coverage with covr
Package coverage: 91.39
Cyclocomplexity with cyclocomp
No functions have cyclocomplexity >= 15
Static code analyses with lintr
lintr found the following 16 potential issues:
| message | number of times |
|---|---|
| Avoid changing the working directory, or restore it in on.exit | 2 |
| Lines should not be more than 80 characters. | 14 |
Package Versions
| package | version |
|---|---|
| pkgstats | 0.0.3.88 |
| pkgcheck | 0.0.2.237 |