pkgcheck results - main

[github-actions]

Checks for pkgdev (v0.1.0.9010)

git hash: 56be9023

• ✔️ Package name is available
• ✔️ has a 'codemeta.json' file.
• ✖️ does not have 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 0% (should be at least 75%).
• ✔️ R CMD check found no errors.
• ✔️ R CMD check found no warnings.

Important: All failing checks above must be addressed prior to proceeding

Package License: MIT + file LICENSE

---

1. Package Dependencies

Details of Package Dependency Usage (click to open)

The table below tallies all function calls to all packages ('ncalls'), both internal (r-base + recommended, along with the package itself), and external (imported and suggested packages). 'NA' values indicate packages to which no identified calls to R functions could be found. Note that these results are generated by an automated code-tagging system which may not be entirely accurate.

type	package	ncalls
internal	base	54
internal	tools	1
imports	knitr	4
imports	devtools	2
imports	codemetar	1
imports	styler	1
imports	usethis	1
imports	cffr	NA
imports	cli	NA
imports	jsonld	NA
imports	jsonvalidate	NA
imports	lintr	NA
imports	magick	NA
imports	pkgdown	NA
imports	remotes	NA
imports	roxygen2	NA
imports	sessioninfo	NA
imports	urlchecker	NA
imports	V8	NA
suggests	covr	NA
suggests	gitdevr	NA
suggests	goodpractice	NA
suggests	rcmdcheck	NA
suggests	rmarkdown	NA
suggests	tidyverse	NA
linking_to	NA	NA

Click below for tallies of functions used in each package. Locations of each call within this package may be generated locally by running 's <- pkgstats::pkgstats(<path/to/repo>)', and examining the 'external_calls' table.

base

file.path (13), source (6), list.files (5), readLines (5), file.copy (4), c (3), dir.exists (3), system.file (3), gsub (2), length (2), file.exists (1), file.remove (1), for (1), grep (1), if (1), isFALSE (1), lapply (1), seq_len (1)

knitr

knit (3), plot_crop (1)

devtools

as.package (1), build_readme (1)

codemetar

write_codemeta (1)

styler

style_pkg (1)

tools

resaveRdaFiles (1)

usethis

use_git_ignore (1)

NOTE: Some imported packages appear to have no associated function calls; please ensure with author that these 'Imports' are listed appropriately.

---

2. 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 7 files) and
• 1 authors
• 1 vignette
• no internal data file
• 17 imported packages
• 7 exported functions (median 39 lines of code)
• 6 non-exported functions in R (median 68 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

All parameters are explained as tooltips in the locally-rendered HTML version of this report generated by the checks_to_markdown() function

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	7	45.7
files_vignettes	1	68.4
files_tests	0	0.0	TRUE
loc_R	335	35.5
loc_vignettes	26	3.4	TRUE
num_vignettes	1	64.8
n_fns_r	13	18.0
n_fns_r_exported	7	34.0
n_fns_r_not_exported	6	12.9
n_fns_per_file_r	1	17.5
num_params_per_fn	3	33.6
loc_per_fn_r	39	84.4
loc_per_fn_r_exp	39	72.0
loc_per_fn_r_not_exp	68	94.2
rel_whitespace_R	33	55.4
rel_whitespace_vignettes	42	7.1
doclines_per_fn_exp	34	40.2
doclines_per_fn_not_exp	0	0.0	TRUE
fn_call_network_size	2	14.4

---

2a. 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.

---

3. goodpractice and other checks

Details of goodpractice checks (click to open)

3a. Continuous Integration Badges

GitHub Workflow Results

id	name	conclusion	sha	run_number	date
5730740408	lintr	success	00364a	4	2023-08-01
5730767093	pages build and deployment	success	58bcd6	132	2023-08-01
5730746135	pkgcheck	NA	00364a	2	2023-08-01
5730740409	pkgdown-gh-pages	success	00364a	192	2023-08-01
5730740412	R-CMD-check	success	00364a	420	2023-08-01
5730740410	update-docs	success	00364a	203	2023-08-01

---

3b. goodpractice results

R CMD check with rcmdcheck

R CMD check generated the following note:

1. checking dependencies in R code ... NOTE
   Namespaces in Imports field not imported from:
   ‘jsonld’ ‘jsonvalidate’ ‘magick’ ‘pkgdown’ ‘remotes’ ‘sessioninfo’
   ‘V8’
   All declared Imports should be used.

R CMD check generated the following check_fail:

1. rcmdcheck_imports_not_imported_from

Test coverage with covr

Package coverage: 0

The following files are not completely covered by tests:

file	coverage
R/add_global_gitgnore.R	0%
R/gha_check_full.R	0%
R/gha_pkgdown_branch.R	0%
R/gha_update_docs.R	0%
R/precompute_vignette.R	0%
R/update_docs.R	0%

Cyclocomplexity with cyclocomp

Error : Failed to install 'pkgdev' from local:
can't convert package usethis with RemoteType 'any' to remote

Static code analyses with lintr

lintr found no issues with this package!

---

Package Versions

package	version
pkgstats	0.1.3.4
pkgcheck	0.1.2.1