github-actions[bot]
commented
1 year ago Checks for nominatimlite (v0.2.0)
git hash: 017b0dfd
- :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_multiplication_x: Package coverage is 21.7% (should be at least 75%).
- :heavy_check_mark: R CMD check found no errors.
- :heavy_check_mark: 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 | 133|
|internal |nominatimlite | 42|
|internal |stats | 6|
|imports |dplyr | 57|
|imports |sf | 20|
|imports |jsonlite | 18|
|imports |utils | 2|
|suggests |ggplot2 | NA|
|suggests |knitr | NA|
|suggests |osmdata | NA|
|suggests |rmarkdown | NA|
|suggests |testthat | NA|
|suggests |tidygeocoder | 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(
url (19), lapply (18), paste0 (18), by (13), tempfile (9), isFALSE (8), names (8), c (5), pmax (4), pmin (4), unique (4), as.character (3), as.double (3), class (2), gsub (2), list (2), nrow (2), seq_len (2), warning (2), length (1), numeric (1), setdiff (1), tryCatch (1), vapply (1)
tibble (32), as_tibble (10), left_join (8), inner_join (4), distinct (2), bind_cols (1)
api_call (10), empty_sf (7), keep_names (6), empty_tbl (5), bbox_to_poly (2), empty_tbl_rev (2), keep_names_rev (2), add_custom_query (1), geo_address_lookup (1), geo_address_lookup_sf (1), geo_amenity (1), geo_amenity_sf (1), reverse_geo_lite_sf_single (1), reverse_geo_lite_single (1), unnest_reverse (1)
read_sf (8), st_as_sf (3), st_crs (3), st_drop_geometry (3), st_as_sfc (1), st_covered_by (1), st_make_valid (1)
fromJSON (18)
df (6)
download.file (2)
base
dplyr
nominatimlite
sf
jsonlite
stats
utils
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 13 files) and - 1 authors - 1 vignette - 1 internal data file - 4 imported packages - 11 exported functions (median 26 lines of code) - 47 non-exported functions in R (median 26 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 | 13| 68.2| | |files_vignettes | 1| 68.4| | |files_tests | 12| 92.5| | |loc_R | 822| 62.6| | |loc_vignettes | 93| 23.2| | |loc_tests | 1062| 87.8| | |num_vignettes | 1| 64.8| | |data_size_total | 1184| 60.8| | |data_size_median | 1184| 65.1| | |n_fns_r | 58| 61.1| | |n_fns_r_exported | 11| 48.6| | |n_fns_r_not_exported | 47| 65.9| | |n_fns_per_file_r | 3| 46.1| | |num_params_per_fn | 8| 88.7| | |loc_per_fn_r | 26| 71.1| | |loc_per_fn_r_exp | 26| 57.4| | |loc_per_fn_r_not_exp | 26| 73.5| | |rel_whitespace_R | 36| 79.8| | |rel_whitespace_vignettes | 53| 38.1| | |rel_whitespace_tests | 31| 91.6| | |doclines_per_fn_exp | 67| 77.7| | |doclines_per_fn_not_exp | 0| 0.0|TRUE | |fn_call_network_size | 70| 73.0| | ---
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/dieghernan/nominatimlite/actions) **GitHub Workflow Results** | id|name |conclusion |sha | run_number|date | |----------:|:----------------------------------------|:----------|:------|----------:|:----------| | 5737963418|Clear all Github actions caches manually |success |d4da5b | 5|2023-08-02 | | 5737985563|lint |success |58d235 | 279|2023-08-02 | | 5739365983|lintr |success |4e4f30 | 7|2023-08-02 | | 5738573429|pages build and deployment |success |389ddd | 89|2023-08-02 | | 5745591229|pkgcheck |NA |017b0d | 2|2023-08-03 | | 5738533596|pkgdown-gh-pages |success |017b0d | 251|2023-08-02 | | 5740885639|R-CMD-check |success |017b0d | 495|2023-08-02 | | 5739365964|test-coverage |success |4e4f30 | 283|2023-08-02 | | 5737811040|update-docs |success |bc16d1 | 120|2023-08-02 | --- #### 3b. `goodpractice` results #### `R CMD check` with [rcmdcheck](https://r-lib.github.io/rcmdcheck/) rcmdcheck found no errors, warnings, or notes #### Test coverage with [covr](https://covr.r-lib.org/) Package coverage: 21.75 The following files are not completely covered by tests: file | coverage --- | --- R/geo_address_lookup_sf.R | 0% R/geo_address_lookup.R | 0% R/geo_amenity_sf.R | 55.38% R/geo_amenity.R | 54.55% R/geo_lite_sf.R | 0% R/geo_lite.R | 0% R/reverse_geo_lite_sf.R | 0% R/reverse_geo_lite.R | 0% R/utils.R | 26.53% #### Cyclocomplexity with [cyclocomp](https://github.com/MangoTheCat/cyclocomp) No functions have cyclocomplexity >= 15 #### Static code analyses with [lintr](https://github.com/jimhester/lintr) [lintr](https://github.com/jimhester/lintr) found no issues with this package!
Package Versions
|package |version | |:--------|:-------| |pkgstats |0.1.3.4 | |pkgcheck |0.1.2.1 |
Checks for nominatimlite (v0.2.0)
git hash: d4da5b6b
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 | 133| |internal |nominatimlite | 42| |internal |stats | 6| |imports |dplyr | 57| |imports |sf | 20| |imports |jsonlite | 18| |imports |utils | 2| |suggests |ggplot2 | NA| |suggests |knitr | NA| |suggests |osmdata | NA| |suggests |rmarkdown | NA| |suggests |testthat | NA| |suggests |tidygeocoder | 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.
base
url (19), lapply (18), paste0 (18), by (13), tempfile (9), isFALSE (8), names (8), c (5), pmax (4), pmin (4), unique (4), as.character (3), as.double (3), class (2), gsub (2), list (2), nrow (2), seq_len (2), warning (2), length (1), numeric (1), setdiff (1), tryCatch (1), vapply (1)
dplyr
tibble (32), as_tibble (10), left_join (8), inner_join (4), distinct (2), bind_cols (1)
nominatimlite
api_call (10), empty_sf (7), keep_names (6), empty_tbl (5), bbox_to_poly (2), empty_tbl_rev (2), keep_names_rev (2), add_custom_query (1), geo_address_lookup (1), geo_address_lookup_sf (1), geo_amenity (1), geo_amenity_sf (1), reverse_geo_lite_sf_single (1), reverse_geo_lite_single (1), unnest_reverse (1)
sf
read_sf (8), st_as_sf (3), st_crs (3), st_drop_geometry (3), st_as_sfc (1), st_covered_by (1), st_make_valid (1)
jsonlite
fromJSON (18)
stats
df (6)
utils
download.file (2)
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 13 files) and - 1 authors - 1 vignette - 1 internal data file - 4 imported packages - 11 exported functions (median 26 lines of code) - 47 non-exported functions in R (median 26 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 | 13| 68.2| | |files_vignettes | 1| 68.4| | |files_tests | 12| 92.5| | |loc_R | 822| 62.6| | |loc_vignettes | 93| 23.2| | |loc_tests | 1062| 87.8| | |num_vignettes | 1| 64.8| | |data_size_total | 1127| 60.6| | |data_size_median | 1127| 64.9| | |n_fns_r | 58| 61.1| | |n_fns_r_exported | 11| 48.6| | |n_fns_r_not_exported | 47| 65.9| | |n_fns_per_file_r | 3| 46.1| | |num_params_per_fn | 8| 88.7| | |loc_per_fn_r | 26| 71.1| | |loc_per_fn_r_exp | 26| 57.4| | |loc_per_fn_r_not_exp | 26| 73.5| | |rel_whitespace_R | 36| 79.8| | |rel_whitespace_vignettes | 53| 38.1| | |rel_whitespace_tests | 31| 91.6| | |doclines_per_fn_exp | 67| 77.7| | |doclines_per_fn_not_exp | 0| 0.0|TRUE | |fn_call_network_size | 70| 73.0| | ---
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/dieghernan/nominatimlite/actions) **GitHub Workflow Results** | id|name |conclusion |sha | run_number|date | |----------:|:----------------------------------------|:----------|:------|----------:|:----------| | 5737963418|Clear all Github actions caches manually |success |d4da5b | 5|2023-08-02 | | 5737531422|CRAN Status Monitor |success |f40acb | 72|2023-08-02 | | 5737985563|lint |success |58d235 | 279|2023-08-02 | | 5737985545|lintr |success |58d235 | 3|2023-08-02 | | 5738021015|pages build and deployment |success |30f3c8 | 88|2023-08-02 | | 5737888202|pkgcheck |NA |d4da5b | 1|2023-08-02 | | 5737985541|pkgdown-gh-pages |success |58d235 | 250|2023-08-02 | | 5737985542|R-CMD-check |NA |58d235 | 490|2023-08-02 | | 5737985560|test-coverage |success |58d235 | 279|2023-08-02 | | 5737811040|update-docs |success |bc16d1 | 120|2023-08-02 | --- #### 3b. `goodpractice` results #### `R CMD check` with [rcmdcheck](https://r-lib.github.io/rcmdcheck/) rcmdcheck found no errors, warnings, or notes #### Test coverage with [covr](https://covr.r-lib.org/) Package coverage: 21.75 The following files are not completely covered by tests: file | coverage --- | --- R/geo_address_lookup_sf.R | 0% R/geo_address_lookup.R | 0% R/geo_amenity_sf.R | 55.38% R/geo_amenity.R | 54.55% R/geo_lite_sf.R | 0% R/geo_lite.R | 0% R/reverse_geo_lite_sf.R | 0% R/reverse_geo_lite.R | 0% R/utils.R | 26.53% #### Cyclocomplexity with [cyclocomp](https://github.com/MangoTheCat/cyclocomp) No functions have cyclocomplexity >= 15 #### Static code analyses with [lintr](https://github.com/jimhester/lintr) [lintr](https://github.com/jimhester/lintr) found no issues with this package!
Package Versions
|package |version | |:--------|:-------| |pkgstats |0.1.3.4 | |pkgcheck |0.1.2.1 |