pkgcheck results - main

[github-actions]

Checks for tidyBdE (v0.3.4)

git hash: 690382ce

• ✔️ 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
• ✖️ These functions do not have examples: [scales_bde].
• ✔️ Package has continuous integration checks.
• ✔️ Package coverage is 99.5%.
• ✔️ 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: 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	94
internal	tidyBdE	37
internal	grDevices	8
internal	stats	2
imports	ggplot2	20
imports	readr	6
imports	tibble	2
imports	utils	2
imports	dplyr	1
imports	scales	NA
imports	tidyr	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 (16), for (8), lapply (8), paste0 (8), names (7), seq_len (6), as.character (4), length (4), switch (4), warning (3), file.path (2), grep (2), readLines (2), tryCatch (2), unlist (2), url (2), vapply (2), file.exists (1), getOption (1), gsub (1), is.null (1), match (1), nrow (1), path.expand (1), rep (1), setdiff (1), substr (1), tolower (1), toupper (1)

tidyBdE

bde_series_load (10), bde_hlp_return_null (6), bde_hlp_download (3), bde_catalog_load (2), bde_catalog_search (1), bde_catalog_update (1), bde_check_access (1), bde_hlp_cachedir (1), bde_hlp_guess (1), bde_hlp_tochar (1), bde_hlp_todouble (1), bde_ind_gdp_quarterly (1), bde_ind_gdp_var (1), bde_ind_ibex_daily (1), bde_ind_ibex_monthly (1), bde_ind_population (1), bde_parse_dates (1), bde_rose_pal (1), bde_series_full_load (1), bde_vivid_pal (1)

ggplot2

element_text (8), element_blank (3), unit (3), element_line (2), element_rect (2), rel (2)

grDevices

palette (8)

readr

locale (6)

stats

end (1), line (1)

tibble

tibble (2)

utils

read.csv2 (2)

dplyr

bind_rows (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 9 files) and
• 1 authors
• 3 vignettes
• no internal data file
• 7 imported packages
• 24 exported functions (median 10 lines of code)
• 37 non-exported functions in R (median 12 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	9	55.2
files_vignettes	3	92.4
files_tests	5	81.7
loc_R	766	60.5
loc_vignettes	383	71.2
loc_tests	184	53.0
num_vignettes	3	94.2
n_fns_r	61	62.9
n_fns_r_exported	24	72.5
n_fns_r_not_exported	37	58.9
n_fns_per_file_r	4	59.3
num_params_per_fn	2	11.9
loc_per_fn_r	12	36.1
loc_per_fn_r_exp	10	24.4
loc_per_fn_r_not_exp	12	39.1
rel_whitespace_R	24	68.4
rel_whitespace_vignettes	31	69.4
rel_whitespace_tests	42	66.2
doclines_per_fn_exp	52	66.2
doclines_per_fn_not_exp	0	0.0	TRUE
fn_call_network_size	44	63.6

---

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
5713100689	Clean pkgdown manually	success	67172e	34	2023-07-31
5625328460	Clear GHA caches manually	success	c763b6	5	2023-07-21
5741458076	CRAN Status Monitor	success	67172e	88	2023-08-02
5751196859	lintr	success	690382	176	2023-08-03
5713176158	pages build and deployment	success	12800d	102	2023-07-31
5751206607	pkgcheck	NA	690382	1	2023-08-03
5751196863	R-CMD-check	NA	690382	419	2023-08-03
5751196861	rostemplate-gh-pages	NA	690382	183	2023-08-03
5751196879	test-coverage	success	690382	176	2023-08-03
5625331896	update-docs	success	c763b6	81	2023-07-21

---

3b. goodpractice results

R CMD check with rcmdcheck

rcmdcheck found no errors, warnings, or notes

Test coverage with covr

Package coverage: 99.54

Cyclocomplexity with cyclocomp

The following functions have cyclocomplexity >= 15:

function	cyclocomplexity
bde_series_full_load	23
bde_series_load	21
bde_catalog_load	17

Static code analyses with lintr

lintr found the following 13 potential issues:

message	number of times
Avoid library() and require() calls in packages	11
Lines should not be more than 80 characters.	2

---

Package Versions

package	version
pkgstats	0.1.3.4
pkgcheck	0.1.2.1

[github-actions]

Checks for tidyBdE (v0.3.4.9000)

git hash: 272672d5

• ✔️ 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 99.6%.
• ✔️ 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	95
internal	tidyBdE	42
internal	grDevices	12
internal	stats	2
imports	ggplot2	20
imports	readr	6
imports	scales	2
imports	tibble	2
imports	utils	2
imports	dplyr	1
imports	lifecycle	NA
imports	tidyr	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 (13), for (8), lapply (8), paste0 (8), names (7), seq_len (7), length (5), as.character (4), rev (4), switch (3), warning (3), file.path (2), grep (2), readLines (2), tryCatch (2), unlist (2), url (2), vapply (2), file.exists (1), getOption (1), gsub (1), is.null (1), match (1), nrow (1), path.expand (1), rep (1), substr (1), tolower (1), toupper (1)

tidyBdE

bde_series_load (10), bde_hlp_return_null (6), bde_catalog_load (3), bde_hlp_download (3), bde_palettes (3), bde_catalog_update (2), bde_catalog_search (1), bde_check_access (1), bde_hlp_cachedir (1), bde_hlp_guess (1), bde_hlp_tochar (1), bde_hlp_todouble (1), bde_ind_gdp_quarterly (1), bde_ind_gdp_var (1), bde_ind_ibex_daily (1), bde_ind_ibex_monthly (1), bde_ind_population (1), bde_parse_dates (1), bde_rose_pal (1), bde_series_full_load (1), bde_vivid_pal (1)

ggplot2

element_text (8), element_blank (3), unit (3), element_line (2), element_rect (2), rel (2)

grDevices

palette (12)

readr

locale (6)

scales

manual_pal (2)

stats

end (1), line (1)

tibble

tibble (2)

utils

read.csv2 (2)

dplyr

bind_rows (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 10 files) and
• 1 authors
• 3 vignettes
• no internal data file
• 8 imported packages
• 27 exported functions (median 8 lines of code)
• 38 non-exported functions in R (median 12 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	10	59.0
files_vignettes	3	92.4
files_tests	8	88.2
loc_R	769	60.6
loc_vignettes	385	71.3
loc_tests	282	62.8
num_vignettes	3	94.2
n_fns_r	65	64.8
n_fns_r_exported	27	75.5
n_fns_r_not_exported	38	59.7
n_fns_per_file_r	4	58.6
num_params_per_fn	2	11.9
loc_per_fn_r	9	24.3
loc_per_fn_r_exp	8	16.3
loc_per_fn_r_not_exp	12	39.1
rel_whitespace_R	25	69.7
rel_whitespace_vignettes	30	69.4
rel_whitespace_tests	46	77.9
doclines_per_fn_exp	56	69.3
doclines_per_fn_not_exp	0	0.0	TRUE
fn_call_network_size	40	61.6

---

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
7680795990	CITATION.cff	success	5bfb73	38	2024-01-27
7681308344	Clear GHA caches manually	success	272672	7	2024-01-27
7670806677	CRAN Status Monitor	success	b604b5	164	2024-01-26
7681301351	lintr	success	272672	211	2024-01-27
7681322922	pages build and deployment with artifacts-next	success	ed9213	117	2024-01-27
7681529528	pkgcheck	NA	272672	3	2024-01-27
7681301355	R-CMD-check	success	272672	479	2024-01-27
7681301354	rostemplate-gh-pages	success	272672	195	2024-01-27
7681301350	test-coverage	success	272672	185	2024-01-27
7680795983	Update CITATION.cff	success	5bfb73	34	2024-01-27
7616463845	update-docs	success	8a2ed6	86	2024-01-22

---

3b. goodpractice results

R CMD check with rcmdcheck

rcmdcheck found no errors, warnings, or notes

Test coverage with covr

Package coverage: 99.6

Cyclocomplexity with cyclocomp

The following functions have cyclocomplexity >= 15:

function	cyclocomplexity
bde_series_full_load	23
bde_series_load	21

Static code analyses with lintr

lintr found the following 13 potential issues:

message	number of times
Avoid library() and require() calls in packages	11
Lines should not be more than 80 characters. This line is 88 characters.	2

---

Package Versions

package	version
pkgstats	0.1.3.9
pkgcheck	0.1.2.11