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

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

pkgcheck results - main #43

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

Comments

@github-actions
Copy link
Contributor

github-actions bot commented Aug 4, 2023

Checks for climaemet (v1.1.1.9000)

git hash: 17c0eca0

  • ✔️ 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 0% (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-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 264
internal climaemet 63
internal utils 34
internal stats 31
internal graphics 6
internal methods 6
internal grDevices 3
internal MASS 1
imports ggplot2 53
imports dplyr 30
imports httr 26
imports tidyr 9
imports tibble 5
imports jsonlite 3
imports rappdirs 2
imports readr 1
imports rlang NA
suggests sf 2
suggests jpeg 1
suggests climatol NA
suggests gganimate NA
suggests knitr NA
suggests lubridate NA
suggests rmarkdown NA
suggests scales 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

c (27), names (25), paste0 (17), for (12), length (10), by (8), seq_len (8), file.path (6), grepl (6), lapply (6), min (6), paste (6), single (6), as.integer (5), as.numeric (5), data.frame (5), seq (5), col (4), date (4), max (4), tempdir (4), vapply (4), as.character (3), as.data.frame (3), as.Date (3), is.na (3), labels (3), round (3), substr (3), sum (3), Sys.getenv (3), dir (2), format (2), ifelse (2), levels (2), mean (2), ncol (2), pi (2), prettyNum (2), readRDS (2), rep (2), rev (2), Sys.Date (2), try (2), tryCatch (2), character (1), cut (1), drop (1), file (1), findInterval (1), floor (1), gsub (1), intersect (1), is.data.frame (1), is.list (1), is.null (1), logical (1), nrow (1), numeric (1), plot (1), readLines (1), scale (1), setdiff (1), sort (1), sub (1), switch (1), system.file (1), t (1), table (1), unique (1), units (1)

climaemet

aemet_stations (12), get_col_first_class (5), aemet_daily_clim (4), aemet_monthly_period (4), get_data_aemet (4), aemet_detect_api_key (3), aemet_normal_clim (3), aemet_daily_period (2), aemet_monthly_clim (2), get_metadata_aemet (2), getlines (2), aemet_api_key (1), aemet_daily_period_all (1), aemet_extremes_clim (1), aemet_forecast_daily (1), aemet_forecast_daily_single (1), aemet_forecast_hourly (1), aemet_forecast_hourly_single (1), aemet_forecast_tidy (1), aemet_forecast_vars_available (1), aemet_hlp_guess (1), aemet_hlp_meta_forecast (1), aemet_hlp_sf (1), aemet_hlp_tidy_forc_daily (1), aemet_hlp_tidy_forc_hourly (1), aemet_last_obs (1), aemet_monthly_period_all (1), aemet_normal_clim_all (1), first_day_of_year (1), getpolymax (1), unnest_all (1)

ggplot2

element_text (13), element_blank (8), ggplot (6), aes (5), unit (3), geom_hline (2), guide_colorbar (2), guides (2), scale_fill_manual (2), theme_minimal (2), coord_polar (1), element_rect (1), facet_wrap (1), geom_bar (1), geom_tile (1), labs (1), scale_fill_gradientn (1), theme (1)

utils

data (31), head (2), tail (1)

stats

end (12), start (6), var (5), df (4), approx (1), formula (1), line (1), poly (1)

dplyr

all_of (8), left_join (6), bind_rows (5), mutate (4), bind_cols (3), rename (2), full_join (1), last_col (1)

httr

content (8), GET (6), add_headers (4), headers (4), status_code (4)

tidyr

pivot_wider (6), unnest (2), drop_na (1)

graphics

title (6)

methods

as (6)

tibble

tibble (4), as_tibble (1)

grDevices

hcl.colors (2), colors (1)

jsonlite

fromJSON (3)

rappdirs

user_cache_dir (2)

sf

st_as_sf (1), st_crs (1)

jpeg

readJPEG (1)

MASS

expand (1)

readr

locale (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 19 files) and
  • 3 authors
  • 6 vignettes
  • 4 internal data files
  • 9 imported packages
  • 31 exported functions (median 30 lines of code)
  • 53 non-exported functions in R (median 36 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 19 79.7
files_vignettes 7 98.5
files_tests 0 0.0 TRUE
loc_R 2268 86.5
loc_vignettes 1310 94.0
num_vignettes 6 98.7 TRUE
data_size_total 69822 81.4
data_size_median 7367 77.1
n_fns_r 84 71.8
n_fns_r_exported 31 79.2
n_fns_r_not_exported 53 69.2
n_fns_per_file_r 3 45.6
num_params_per_fn 4 67.3
loc_per_fn_r 34 81.2
loc_per_fn_r_exp 30 63.0
loc_per_fn_r_not_exp 36 83.5
rel_whitespace_R 22 88.7
rel_whitespace_vignettes 28 94.4
doclines_per_fn_exp 53 66.3
doclines_per_fn_not_exp 0 0.0 TRUE
fn_call_network_size 89 77.3

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

roscron-check-full.yaml

GitHub Workflow Results

id name conclusion sha run_number date
5762075410 CRAN Status Monitor success 2a159f 89 2023-08-04
5763740501 lintr success bbfff0 5 2023-08-04
5762900860 pages build and deployment success 5ccc36 165 2023-08-04
5763635996 pkgcheck NA 17c0ec 1 2023-08-04
5763740504 R-CMD-check success bbfff0 333 2023-08-04
5763740496 R-CMD-check-examples NA bbfff0 415 2023-08-04
5762777159 rostemplate-gh-pages success 17c0ec 264 2023-08-04
5750148454 update-docs success 30751b 60 2023-08-03

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 8737 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: 0

The following files are not completely covered by tests:

file coverage
R/aemet_api_key.R 0%
R/aemet_api_query.R 0%
R/aemet_daily.R 0%
R/aemet_extremes.R 0%
R/aemet_forecast_daily.R 0%
R/aemet_forecast_hourly.R 0%
R/aemet_forecast_utils.R 0%
R/aemet_last_obs.R 0%
R/aemet_monthly.R 0%
R/aemet_normal.R 0%
R/aemet_stations.R 0%
R/climaemet_news.R 0%
R/climatogram.R 0%
R/helpers.R 0%
R/stripes.R 0%
R/utils.R 0%
R/windrose.R 0%

Cyclocomplexity with cyclocomp

The following functions have cyclocomplexity >= 15:

function cyclocomplexity
ggclimat_walter_lieth 40
ggwindrose 39
aemet_daily_clim 23
get_data_aemet 23
get_metadata_aemet 23
ggstripes 16

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