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 #10

Open
github-actions bot opened this issue Jan 15, 2024 · 0 comments
Open

pkgcheck results - main #10

github-actions bot opened this issue Jan 15, 2024 · 0 comments

Comments

@github-actions
Copy link
Contributor

Checks for arcgeocoder (v0.1.0)

git hash: d85bcf36

  • ✔️ Package name is available
  • ✔️ 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.5%.
  • ✔️ R CMD check found no errors.
  • ✔️ R CMD check found no warnings.

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 89
internal arcgeocoder 22
internal utils 3
internal stats 1
imports dplyr 22
imports jsonlite 5
suggests knitr 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(<path/to/repo>)', and examining the 'external_calls' table.

base

lapply (10), paste0 (9), names (7), pmax (6), pmin (6), url (5), length (4), by (3), c (3), max (3), min (3), seq (3), tempfile (3), vapply (3), isFALSE (2), nrow (2), numeric (2), strsplit (2), unique (2), unlist (2), warning (2), as.list (1), is.data.frame (1), lengths (1), list (1), logical (1), seq_len (1), tryCatch (1)

arcgeocoder

arc_api_call (4), arc_geo (2), arc_reverse_geo_single (2), add_custom_query (1), arc_geo_categories (1), arc_geo_multi (1), arc_geo_single (1), arc_reverse_geo (1), arcgeocoder_check_access (1), empty_tbl (1), empty_tbl_rev (1), input_multi (1), keep_names (1), keep_names_rev (1), unnest_geo (1), unnest_reverse (1), validate_location (1)

dplyr

tibble (9), as_tibble (6), bind_cols (3), left_join (2), bind_rows (1), distinct (1)

jsonlite

fromJSON (5)

utils

txtProgressBar (3)

stats

end (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 8 files) and
  • 1 authors
  • 4 vignettes
  • 2 internal data files
  • 2 imported packages
  • 6 exported functions (median 37 lines of code)
  • 34 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 8 50.7
files_vignettes 5 96.9
files_tests 6 84.4
loc_R 544 50.1
loc_vignettes 455 75.8
loc_tests 622 79.1
num_vignettes 4 96.6 TRUE
data_size_total 192640 87.0
data_size_median 96320 91.1
n_fns_r 40 49.3
n_fns_r_exported 6 29.1
n_fns_r_not_exported 34 56.6
n_fns_per_file_r 3 54.5
num_params_per_fn 12 96.6 TRUE
loc_per_fn_r 27 72.7
loc_per_fn_r_exp 37 70.2
loc_per_fn_r_not_exp 26 73.1
rel_whitespace_R 32 67.3
rel_whitespace_vignettes 40 82.4
rel_whitespace_tests 28 83.0
doclines_per_fn_exp 98 90.5
doclines_per_fn_not_exp 0 0.0 TRUE
fn_call_network_size 22 48.5

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

check-full.yaml

GitHub Workflow Results

id name conclusion sha run_number date
7521708690 Clear all Github actions caches manually success b6c5b0 3 2024-01-14
7532221254 lintr success d85bcf 42 2024-01-15
7520690501 pages build and deployment success 91a20f 26 2024-01-14
7532251892 pages build and deployment with artifacts-next success 3ff296 30 2024-01-15
7532330440 pkgcheck NA d85bcf 1 2024-01-15
7532221258 pkgdown-gh-pages success d85bcf 31 2024-01-15
7532221257 R-CMD-check success d85bcf 43 2024-01-15
7532221251 test-coverage success d85bcf 41 2024-01-15
7520636992 update-docs success 05e7ef 2 2024-01-14

3b. goodpractice results

R CMD check with rcmdcheck

rcmdcheck found no errors, warnings, or notes

Test coverage with covr

Package coverage: 99.46

Cyclocomplexity with cyclocomp

No functions have cyclocomplexity >= 15

Static code analyses with lintr

lintr found the following 26 potential issues:

message number of times
Avoid library() and require() calls in packages 10
Lines should not be more than 80 characters. This line is 104 characters. 4
Lines should not be more than 80 characters. This line is 105 characters. 2
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 123 characters. 2
Lines should not be more than 80 characters. This line is 96 characters. 1
Lines should not be more than 80 characters. This line is 97 characters. 3
Lines should not be more than 80 characters. This line is 98 characters. 1
Lines should not be more than 80 characters. This line is 99 characters. 2


Package Versions

package version
pkgstats 0.1.3.9
pkgcheck 0.1.2.11

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