github-actions[bot]
commented
1 year ago Checks for giscoR (v0.3.5.9000)
git hash: eab8abde
- :heavy_check_mark: Package is already on CRAN.
- :heavy_check_mark: has a 'codemeta.json' file.
- :heavy_check_mark: has a 'contributing' file.
- :heavy_check_mark: uses 'roxygen2'.
- :heavy_check_mark: 'DESCRIPTION' has a URL field.
- :heavy_check_mark: 'DESCRIPTION' has a BugReports field.
- :heavy_check_mark: Package has at least one HTML vignette
- :heavy_check_mark: All functions have examples.
- :heavy_check_mark: Package has continuous integration checks.
- :heavy_check_mark: Package coverage is 97.5%.
- :heavy_check_mark: R CMD check found no errors.
- :heavy_check_mark: 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 | 159|
|internal |giscoR | 42|
|internal |tools | 3|
|internal |graphics | 1|
|internal |stats | 1|
|imports |sf | 9|
|imports |utils | 6|
|imports |rappdirs | 3|
|imports |countrycode | 1|
|imports |geojsonsf | NA|
|suggests |eurostat | NA|
|suggests |ggplot2 | NA|
|suggests |knitr | NA|
|suggests |lwgeom | 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(
basename (19), file.path (12), url (12), paste0 (10), names (9), paste (9), try (9), c (8), q (7), grep (6), strsplit (5), unlist (5), length (4), list (4), getOption (3), gsub (3), suppressWarnings (3), file.exists (2), file.size (2), for (2), is.na (2), local (2), seq_len (2), which (2), as.character (1), as.data.frame (1), as.integer (1), eval (1), file (1), max (1), nchar (1), parse (1), rbind (1), readLines (1), switch (1), Sys.getenv (1), tempfile (1), tolower (1), tryCatch (1), vapply (1), warning (1)
gsc_api_cache (11), gsc_api_url (8), gsc_helper_detect_cache_dir (3), gisco_clear_cache (2), gsc_api_load (2), gsc_load_shp (2), gisco_attributions (1), gisco_bulk_download (1), gisco_check_access (1), gisco_detect_cache_dir (1), gisco_get_airports (1), gisco_get_coastallines (1), gisco_get_communes (1), gisco_get_countries (1), gisco_get_grid (1), gisco_set_cache_dir (1), gsc_helper_cachedir (1), gsc_units_df (1), gsc_units_sf (1), set_utf8 (1)
st_read (6), st_crs (1), st_drop_geometry (1), st_geometry (1)
unzip (4), menu (1), read.csv2 (1)
user_config_dir (3)
file_path_sans_ext (3)
countryname (1)
text (1)
df (1)
base
giscoR
sf
utils
rappdirs
tools
countrycode
graphics
stats
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 19 files) and - 1 authors - 2 vignettes - 6 internal data files - 5 imported packages - 19 exported functions (median 34 lines of code) - 47 non-exported functions in R (median 42 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](https://docs.ropensci.org/pkgcheck/reference/checks_to_markdown.html) 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 | 19| 79.7| | |files_vignettes | 2| 85.7| | |files_tests | 16| 94.9| | |loc_R | 1453| 77.3| | |loc_vignettes | 268| 60.0| | |loc_tests | 898| 85.3| | |num_vignettes | 2| 89.2| | |data_size_total | 700244| 93.6| | |data_size_median | 96938| 91.2| | |n_fns_r | 66| 65.1| | |n_fns_r_exported | 19| 65.9| | |n_fns_r_not_exported | 47| 65.9| | |n_fns_per_file_r | 2| 34.5| | |num_params_per_fn | 5| 69.6| | |loc_per_fn_r | 38| 83.4| | |loc_per_fn_r_exp | 34| 67.5| | |loc_per_fn_r_not_exp | 42| 87.1| | |rel_whitespace_R | 25| 83.5| | |rel_whitespace_vignettes | 25| 49.2| | |rel_whitespace_tests | 20| 83.6| | |doclines_per_fn_exp | 79| 84.1| | |doclines_per_fn_not_exp | 0| 0.0|TRUE | |fn_call_network_size | 113| 81.2| | ---
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 [](https://github.com/rOpenGov/giscoR/actions) **GitHub Workflow Results** | id|name |conclusion |sha | run_number|date | |----------:|:--------------------------|:----------|:------|----------:|:----------| | 5745451320|CITATION-cff |success |8f2c71 | 158|2023-08-03 | | 5743386423|Clear GHA caches manually |success |d2be5d | 11|2023-08-02 | | 5745567210|lintr |success |eab8ab | 8|2023-08-03 | | 5745545242|pages build and deployment |success |be351f | 76|2023-08-03 | | 5745574474|pkgcheck |NA |eab8ab | 2|2023-08-03 | | 5745451322|R-CMD-check |success |8f2c71 | 721|2023-08-03 | | 5745451323|rogtemplate-gh-pages |success |8f2c71 | 132|2023-08-03 | | 5745451327|test-coverage |success |8f2c71 | 624|2023-08-03 | | 5745459810|update-docs |success |8f2c71 | 188|2023-08-03 | --- #### 3b. `goodpractice` results #### `R CMD check` with [rcmdcheck](https://r-lib.github.io/rcmdcheck/) R CMD check generated the following note: 1. checking data for non-ASCII characters ... NOTE Note: found 1178 marked UTF-8 strings R CMD check generated the following check_fail: 1. rcmdcheck_non_ascii_characters_in_data #### Test coverage with [covr](https://covr.r-lib.org/) Package coverage: 97.47 #### Cyclocomplexity with [cyclocomp](https://github.com/MangoTheCat/cyclocomp) The following functions have cyclocomplexity >= 15: function | cyclocomplexity --- | --- gisco_get_lau | 26 gsc_api_url | 22 gisco_get_nuts | 19 gisco_get_countries | 18 gisco_get_units | 16 gsc_helper_detect_cache_dir | 16 gsc_units_sf | 15 #### Static code analyses with [lintr](https://github.com/jimhester/lintr) [lintr](https://github.com/jimhester/lintr) found the following 15 potential issues: message | number of times --- | --- Avoid library() and require() calls in packages | 6 Lines should not be more than 80 characters. | 9
Package Versions
|package |version | |:--------|:-------| |pkgstats |0.1.3.4 | |pkgcheck |0.1.2.1 |
Checks for giscoR (v0.3.5.9000)
git hash: 282078e0
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 | 160| |internal |giscoR | 42| |internal |tools | 3| |internal |graphics | 1| |internal |stats | 1| |imports |sf | 10| |imports |utils | 6| |imports |rappdirs | 3| |imports |countrycode | 1| |imports |geojsonsf | NA| |suggests |eurostat | NA| |suggests |ggplot2 | NA| |suggests |knitr | NA| |suggests |lwgeom | 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()', and examining the 'external_calls' table.
**NOTE:** Some imported packages appear to have no associated function calls; please ensure with author that these 'Imports' are listed appropriately.
base
basename (19), file.path (12), url (12), paste0 (10), c (9), names (9), paste (9), try (9), q (7), grep (6), strsplit (5), unlist (5), length (4), list (4), getOption (3), gsub (3), suppressWarnings (3), file.exists (2), file.size (2), for (2), is.na (2), local (2), seq_len (2), which (2), as.character (1), as.data.frame (1), as.integer (1), eval (1), file (1), max (1), nchar (1), parse (1), rbind (1), readLines (1), switch (1), Sys.getenv (1), tempfile (1), tolower (1), tryCatch (1), vapply (1), warning (1)
giscoR
gsc_api_cache (11), gsc_api_url (8), gsc_helper_detect_cache_dir (3), gisco_clear_cache (2), gsc_api_load (2), gsc_load_shp (2), gisco_attributions (1), gisco_bulk_download (1), gisco_check_access (1), gisco_detect_cache_dir (1), gisco_get_airports (1), gisco_get_coastallines (1), gisco_get_communes (1), gisco_get_countries (1), gisco_get_grid (1), gisco_set_cache_dir (1), gsc_helper_cachedir (1), gsc_units_df (1), gsc_units_sf (1), set_utf8 (1)
sf
st_read (7), st_crs (1), st_drop_geometry (1), st_geometry (1)
utils
unzip (4), menu (1), read.csv2 (1)
rappdirs
user_config_dir (3)
tools
file_path_sans_ext (3)
countrycode
countryname (1)
graphics
text (1)
stats
df (1)
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 19 files) and - 1 authors - 2 vignettes - 6 internal data files - 5 imported packages - 19 exported functions (median 34 lines of code) - 47 non-exported functions in R (median 42 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](https://docs.ropensci.org/pkgcheck/reference/checks_to_markdown.html) 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 | 19| 79.7| | |files_vignettes | 2| 85.7| | |files_tests | 16| 94.9| | |loc_R | 1445| 77.2| | |loc_vignettes | 268| 60.0| | |loc_tests | 891| 85.2| | |num_vignettes | 2| 89.2| | |data_size_total | 700244| 93.6| | |data_size_median | 96938| 91.2| | |n_fns_r | 66| 65.1| | |n_fns_r_exported | 19| 65.9| | |n_fns_r_not_exported | 47| 65.9| | |n_fns_per_file_r | 2| 34.5| | |num_params_per_fn | 5| 69.6| | |loc_per_fn_r | 38| 83.4| | |loc_per_fn_r_exp | 34| 67.5| | |loc_per_fn_r_not_exp | 42| 87.1| | |rel_whitespace_R | 25| 83.5| | |rel_whitespace_vignettes | 25| 49.2| | |rel_whitespace_tests | 21| 83.6| | |doclines_per_fn_exp | 79| 84.1| | |doclines_per_fn_not_exp | 0| 0.0|TRUE | |fn_call_network_size | 113| 81.2| | ---
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.
goodpracticeand other checksDetails of goodpractice checks (click to open)
#### 3a. Continuous Integration Badges [](https://github.com/rOpenGov/giscoR/actions) **GitHub Workflow Results** | id|name |conclusion |sha | run_number|date | |----------:|:--------------------------|:----------|:------|----------:|:----------| | 5743538592|CITATION-cff |success |8850e9 | 157|2023-08-02 | | 5743386423|Clear GHA caches manually |success |d2be5d | 11|2023-08-02 | | 5737580803|CRAN Status Monitor |success |2d820f | 72|2023-08-02 | | 5743538597|lintr |success |8850e9 | 6|2023-08-02 | | 5743636202|pages build and deployment |success |8961a9 | 74|2023-08-02 | | 5745121640|pkgcheck |NA |282078 | 1|2023-08-03 | | 5743538586|R-CMD-check |success |8850e9 | 720|2023-08-02 | | 5743538590|rogtemplate-gh-pages |success |8850e9 | 131|2023-08-02 | | 5743538596|test-coverage |success |8850e9 | 623|2023-08-02 | | 5743543219|update-docs |success |8850e9 | 187|2023-08-02 | --- #### 3b. `goodpractice` results #### `R CMD check` with [rcmdcheck](https://r-lib.github.io/rcmdcheck/) R CMD check generated the following note: 1. checking data for non-ASCII characters ... NOTE Note: found 1178 marked UTF-8 strings R CMD check generated the following check_fail: 1. rcmdcheck_non_ascii_characters_in_data #### Test coverage with [covr](https://covr.r-lib.org/) Package coverage: 97.46 #### Cyclocomplexity with [cyclocomp](https://github.com/MangoTheCat/cyclocomp) The following functions have cyclocomplexity >= 15: function | cyclocomplexity --- | --- gisco_get_lau | 26 gsc_api_url | 22 gsc_helper_detect_cache_dir | 21 gisco_get_nuts | 19 gisco_get_countries | 18 gisco_get_units | 16 gsc_units_sf | 15 #### Static code analyses with [lintr](https://github.com/jimhester/lintr) [lintr](https://github.com/jimhester/lintr) found the following 16 potential issues: message | number of times --- | --- Avoid library() and require() calls in packages | 6 Lines should not be more than 80 characters. | 10
4. Other Checks
Details of other checks (click to open)
:heavy_multiplication_x: Package contains the following unexpected files: - data-raw/PORT_2009_SH/shape/metadata/XML/Thumbs.db - data-raw/PORT_2013_SH/Metadata/Thumbs.db
Package Versions
|package |version | |:--------|:-------| |pkgstats |0.1.3.4 | |pkgcheck |0.1.2.1 |