Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pkgcheck results - main #5

Open
github-actions bot opened this issue Aug 13, 2023 · 0 comments
Open

pkgcheck results - main #5

github-actions bot opened this issue Aug 13, 2023 · 0 comments

Comments

@github-actions
Copy link
Contributor

Checks for CatastRoNav (v0.0.2.9000)

git hash: 3124ad22

  • ✔️ Package name is available
  • ✔️ has a 'codemeta.json' file.
  • ✖️ does not have 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 92.4%.
  • ✔️ 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: CC BY 4.0


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 25
internal CatastRoNav 22
internal utils 2
internal graphics 1
imports sf 6
imports xml2 2
imports tibble 1
imports stringi NA
suggests CatastRo NA
suggests dplyr NA
suggests ggplot2 NA
suggests knitr NA
suggests mapSpain 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

list (3), paste0 (3), q (2), readLines (2), try (2), unlist (2), as.double (1), basename (1), c (1), file.exists (1), file.path (1), file.size (1), names (1), suppressWarnings (1), tempfile (1), tryCatch (1), warning (1)

CatastRoNav

wfs_api_query (4), wfs_bbox (3), wfs_results (3), catr_hlp_dwnload (2), catrnav_wfs_check (2), catrnav_wfs_get_url (2), st_read_layers_encoding (2), catrnav_wfs_get_address_bbox (1), catrnav_wfs_get_buildings_bbox (1), catrnav_wfs_get_parcels_bbox (1), get_sf_from_bbox (1)

sf

st_bbox (2), st_layers (1), st_point (1), st_sfc (1), st_transform (1)

utils

download.file (2)

xml2

as_list (1), read_xml (1)

graphics

lines (1)

tibble

tibble (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 7 files) and
  • 1 authors
  • 1 vignette
  • no internal data file
  • 4 imported packages
  • 3 exported functions (median 12 lines of code)
  • 19 non-exported functions in R (median 25 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 1 68.4
files_tests 5 81.7
loc_R 265 29.3
loc_vignettes 124 32.3
loc_tests 150 48.6
num_vignettes 1 64.8
n_fns_r 22 30.4
n_fns_r_exported 3 12.9
n_fns_r_not_exported 19 39.2
n_fns_per_file_r 2 32.9
num_params_per_fn 3 33.6
loc_per_fn_r 18 56.7
loc_per_fn_r_exp 12 27.7
loc_per_fn_r_not_exp 25 72.0
rel_whitespace_R 25 41.7
rel_whitespace_vignettes 40 38.8
rel_whitespace_tests 41 61.1
doclines_per_fn_exp 40 50.1
doclines_per_fn_not_exp 0 0.0 TRUE
fn_call_network_size 14 39.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

R-CMD-check

GitHub Workflow Results

id name conclusion sha run_number date
5490100632 Clean pkgdown manually success acaf88 7 2023-07-07
5845549978 lintr success 3124ad 2 2023-08-13
5845564197 pages build and deployment success e25345 39 2023-08-13
5846107913 pkgcheck NA 3124ad 1 2023-08-13
5845549981 R-CMD-check success 3124ad 32 2023-08-13
5845549979 rostemplate-gh-pages success 3124ad 16 2023-08-13
5845549980 test-coverage success 3124ad 18 2023-08-13
5713105683 update-docs success b79f7d 22 2023-07-31

3b. goodpractice results

R CMD check with rcmdcheck

rcmdcheck found no errors, warnings, or notes

Test coverage with covr

Package coverage: 92.44

Cyclocomplexity with cyclocomp

The following function have cyclocomplexity >= 15:

function cyclocomplexity
catr_hlp_dwnload 24

Static code analyses with lintr

lintr found no issues with this package!


Package Versions

package version
pkgstats 0.1.3.4
pkgcheck 0.1.2.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

0 participants