rOpenSpain / CatastRo

R package to query Sede Electrónica del Catastro (Spain)

Home Page:http://ropenspain.github.io/CatastRo/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

pkgcheck results - main

github-actions opened this issue · comments

Checks for CatastRo (v0.3.0)

git hash: 251e6657

  • ✔️ 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 54.4% (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: GPL-2


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 187
internal CatastRo 84
internal utils 7
internal stats 5
internal graphics 3
imports tibble 21
imports httr 11
imports sf 11
imports xml2 9
imports dplyr 6
imports mapSpain 2
imports rappdirs 2
imports stringi NA
imports terra NA
suggests ggplot2 NA
suggests knitr NA
suggests png NA
suggests rmarkdown NA
suggests slippymath NA
suggests testthat NA
suggests tidyterra 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

unlist (21), paste0 (19), all (13), basename (12), list (12), grep (11), url (10), lapply (7), c (6), file.path (6), gsub (5), strsplit (5), as.double (4), character (4), names (4), switch (4), vapply (4), as.character (3), list.files (3), q (3), readLines (3), tempfile (3), try (3), unique (3), as.integer (2), as.POSIXct (2), attr (2), date (2), sprintf (2), tempdir (2), as.vector (1), file.exists (1), file.size (1), options (1), seq (1), Sys.getenv (1), version (1)

CatastRo

catr_hlp_dwnload (13), wfs_api_query (11), wfs_results (11), catr_read_atom (6), st_read_layers_encoding (5), catr_atom_get_address_db_all (4), catr_atom_get_buildings_db_all (3), catr_atom_get_parcels_db_all (3), catr_hlp_detect_cache_dir (3), wfs_bbox (3), catr_atom_get_address_db_to (2), catr_atom_get_buildings_db_to (2), catr_atom_get_parcels_db_to (2), catr_ovc_get_cod_munic (2), get_sf_from_bbox (2), catr_atom_get_address (1), catr_atom_get_buildings (1), catr_atom_get_parcels (1), catr_atom_search_munic (1), catr_clear_cache (1), catr_detect_cache_dir (1), catr_get_code_from_coords (1), catr_hlp_cachedir (1), catr_hlp_dwn_verbose (1), catr_set_cache_dir (1), catr_wfs_check (1), catr_wfs_get_buildingsild_url (1)

tibble

tibble (11), as_tibble_row (6), deframe (4)

httr

content (3), GET (3), parse_url (3), modify_url (2)

sf

st_bbox (2), st_intersects (2), st_layers (2), st_area (1), st_centroid (1), st_point (1), st_sfc (1), st_transform (1)

xml2

as_list (6), read_xml (3)

utils

unzip (3), download.file (2), modifyList (2)

dplyr

bind_cols (4), bind_rows (1), left_join (1)

stats

df (5)

graphics

title (2), lines (1)

mapSpain

esp_get_munic_siane (1), esp_getTiles (1)

rappdirs

user_config_dir (2)

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 25 files) and
  • 2 authors
  • 2 vignettes
  • 1 internal data file
  • 9 imported packages
  • 31 exported functions (median 18 lines of code)
  • 59 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

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 25 86.3
files_vignettes 2 85.7
files_tests 19 96.0
loc_R 1394 76.5
loc_vignettes 298 63.2
loc_tests 752 82.5
num_vignettes 2 89.2
data_size_total 390 58.0
data_size_median 390 58.9
n_fns_r 90 73.7
n_fns_r_exported 31 79.2
n_fns_r_not_exported 59 72.0
n_fns_per_file_r 2 34.6
num_params_per_fn 4 54.6
loc_per_fn_r 23 66.0
loc_per_fn_r_exp 18 42.5
loc_per_fn_r_not_exp 26 73.5
rel_whitespace_R 30 86.0
rel_whitespace_vignettes 44 73.4
rel_whitespace_tests 29 86.3
doclines_per_fn_exp 78 83.8
doclines_per_fn_not_exp 0 0.0 TRUE
fn_call_network_size 85 76.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

R-CMD-check

GitHub Workflow Results

id name conclusion sha run_number date
7562916141 Clear GHA caches manually success 6427d3 4 2024-01-17
7570586915 lintr success 251e66 34 2024-01-18
7570667415 pages build and deployment with artifacts-next success 104bf4 106 2024-01-18
7571081215 pkgcheck NA 251e66 3 2024-01-18
7570586895 R-CMD-check success 251e66 311 2024-01-18
7570586909 rostemplate-gh-pages success 251e66 70 2024-01-18
7570586899 test-coverage success 251e66 122 2024-01-18
7555278251 update-docs success 37f07f 35 2024-01-17

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 3 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: 54.37

The following files are not completely covered by tests:

file coverage
R/ovc_cpmrc.R 20%
R/ovc_munic.R 0%
R/ovc_provinces.R 0%
R/ovc_rccoor_distancia.R 19.64%
R/ovc_rccoor.R 19.64%
R/search_coords.R 0%
R/utils_wfs.R 26.04%
R/wfs_ad.R 18.52%
R/wfs_bu.R 40.48%
R/wfs_cp.R 14.29%
R/wms_all.R 24.07%

Cyclocomplexity with cyclocomp

The following function have cyclocomplexity >= 15:

function cyclocomplexity
catr_set_cache_dir 15

Static code analyses with lintr

lintr found the following 26 potential issues:

message number of times
Lines should not be more than 80 characters. This line is 101 characters. 1
Lines should not be more than 80 characters. This line is 107 characters. 3
Lines should not be more than 80 characters. This line is 108 characters. 1
Lines should not be more than 80 characters. This line is 109 characters. 2
Lines should not be more than 80 characters. This line is 110 characters. 1
Lines should not be more than 80 characters. This line is 122 characters. 2
Lines should not be more than 80 characters. This line is 123 characters. 1
Lines should not be more than 80 characters. This line is 127 characters. 1
Lines should not be more than 80 characters. This line is 128 characters. 1
Lines should not be more than 80 characters. This line is 141 characters. 1
Lines should not be more than 80 characters. This line is 142 characters. 1
Lines should not be more than 80 characters. This line is 82 characters. 3
Lines should not be more than 80 characters. This line is 87 characters. 1
Lines should not be more than 80 characters. This line is 88 characters. 3
Lines should not be more than 80 characters. This line is 90 characters. 3
Lines should not be more than 80 characters. This line is 98 characters. 1


Package Versions

package version
pkgstats 0.1.3.9
pkgcheck 0.1.2.11