pkgcheck results - main

[github-actions]

pkgcheck results - main

[github-actions]

Checks for igoR (v0.1.5)

git hash: d9e37371

• ✔️ Package is already on CRAN.
• ✔️ 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 100%.
• ✔️ R CMD check found no errors.
• ✔️ R CMD check found no warnings.

Package License: GPL (>= 3)

---

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	78
internal	igoR	11
internal	stats	5
imports	NA	NA
suggests	countrycode	NA
suggests	dplyr	NA
suggests	ggplot2	NA
suggests	knitr	NA
suggests	rmarkdown	NA
suggests	testthat	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

c (15), seq_len (7), colnames (6), data.frame (6), for (5), length (5), max (5), merge (4), unique (4), by (3), list (3), match (3), as.matrix (2), min (2), as.character (1), as.data.frame (1), dim (1), grep (1), matrix (1), mode (1), ncol (1), vector (1)

igoR

igo_search_states (5), igo_dyadic (2), igo_members (1), igo_search (1), igo_state_membership (1), state_year_format3$state (1)

stats

aggregate (3), df (2)

NOTE: No imported packages appear to have 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
• 3 vignettes
• 3 internal data files
• 1 imported package
• 5 exported functions (median 74 lines of code)
• 5 non-exported functions in R (median 131 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	5	96.9
files_tests	5	81.7
loc_R	428	42.7
loc_vignettes	591	81.8
loc_tests	71	32.3
num_vignettes	3	94.2
data_size_total	420088	91.1
data_size_median	201562	94.1
n_fns_r	10	13.0
n_fns_r_exported	5	24.2
n_fns_r_not_exported	5	10.4
n_fns_per_file_r	1	0.2	TRUE
num_params_per_fn	3	33.6
loc_per_fn_r	76	95.1	TRUE
loc_per_fn_r_exp	74	87.9
loc_per_fn_r_not_exp	131	98.3	TRUE
rel_whitespace_R	25	54.5
rel_whitespace_vignettes	21	71.7
rel_whitespace_tests	15	23.6
doclines_per_fn_exp	50	63.0
doclines_per_fn_not_exp	0	0.0	TRUE
fn_call_network_size	13	37.5

---

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
5736698480	CITATION-cff	success	d9e373	142	2023-08-02
5736698479	lintr	success	d9e373	6	2023-08-02
5735990582	pages build and deployment	success	15e331	94	2023-08-02
5736701462	pkgcheck	NA	d9e373	2	2023-08-02
5736698485	pkgdown-gh-pages	NA	d9e373	219	2023-08-02
5736698476	R-CMD-check	NA	d9e373	522	2023-08-02
5736698493	test-coverage	success	d9e373	377	2023-08-02
5736698475	Update CITATION.cff	success	d9e373	12	2023-08-02
5735928282	update-docs	success	e7561c	132	2023-08-02

---

3b. goodpractice results

R CMD check with rcmdcheck

R CMD check generated the following note:

1. checking data for non-ASCII characters ... NOTE
   Note: found 160 marked UTF-8 strings

R CMD check generated the following check_fail:

1. rcmdcheck_non_ascii_characters_in_data

Test coverage with covr

Package coverage: 100

Cyclocomplexity with cyclocomp

The following function have cyclocomplexity >= 15:

function	cyclocomplexity
igo_dyadic	21

Static code analyses with lintr

lintr found the following 5 potential issues:

message	number of times
Avoid library() and require() calls in packages	5

---

Package Versions

package	version
pkgstats	0.1.3.4
pkgcheck	0.1.2.1