ropensci / concstats

Market Structure, Concentration, and Inequality Measures
https://docs.ropensci.org/concstats
GNU General Public License v3.0
7 stars 2 forks source link

pkgcheck results - master #4

Open github-actions[bot] opened 7 months ago

github-actions[bot] commented 7 months ago

Checks for concstats (v0.2.0)

git hash: c450c9e1

Important: All failing checks above must be addressed prior to proceeding

Package License: GPL (>= 3)


1. rOpenSci Statistical Standards (srr package)

This package is in the following category:

:heavy_multiplication_x: Package can not be submitted because the following standards [v0.2.0] are missing from your code:

G1.2 G1.3 G1.4 G1.4a G1.5 G1.6 G2.0 G2.0a G2.1 G2.1a G2.2 G2.3 G2.3a G2.3b G2.4 G2.4a G2.4b G2.4c G2.4d G2.4e G2.5 G2.6 G2.7 G2.8 G2.9 G2.10 G2.11 G2.12 G2.13 G2.14 G2.14a G2.14b G2.14c G2.15 G2.16 G3.1 G3.1a G4.0 G5.6 G5.6a G5.6b G5.7 G5.8d G5.9b G5.10 G5.11 G5.11a G5.12 EA1.1 EA1.3 EA2.0 EA2.1 EA2.2 EA2.2a EA2.2b EA2.3 EA2.4 EA2.5 EA2.6 EA3.0 EA3.1 EA4.0 EA4.1 EA4.2 EA5.0 EA5.0a EA5.0b EA5.1 EA5.2 EA5.3 EA5.4 EA5.5 EA5.6 EA6.1

Click to see the report of author-reported standards compliance of the package with links to associated lines of code, which can be re-generated locally by running the srr_report() function from within a local clone of the repository.


2. 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 | 115| |internal |concstats | 45| |internal |stats | 5| |imports |NA | NA| |suggests |rmarkdown | NA| |suggests |knitr | NA| |suggests |dplyr | NA| |suggests |devtools | NA| |suggests |kableExtra | NA| |suggests |ggplot2 | NA| |suggests |testthat | NA| |suggests |covr | 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

sum (38), as.numeric (29), c (12), try (9), data.frame (7), cut (4), format (4), seq (4), as.data.frame (3), length (2), log (2), seq_len (1)

concstats

concstats_firm (4), concstats_entropy (3), concstats_hhi (3), concstats_nrs_eq (3), concstats_palma (3), concstats_top (3), concstats_dom (2), concstats_gini (2), concstats_grs (2), concstats_hhi_d (2), concstats_hhi_min (2), concstats_simpson (2), concstats_sten (2), concstats_top3 (2), concstats_top5 (2), concstats_all_comp (1), concstats_all_inequ (1), concstats_all_mstruct (1), concstats_comp (1), concstats_concstats (1), concstats_inequ (1), concstats_mstruct (1), concstats_shares (1)

stats

quantile (4), na.omit (1)

**NOTE:** No imported packages appear to have associated function calls; please ensure with author that these 'Imports' are listed appropriately.


3. 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 28 files) and - 1 authors - 2 vignettes - 1 internal data file - 1 imported package - 26 exported functions (median 29 lines of code) - 26 non-exported functions in R (median 39 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 | 28| 88.2| | |files_vignettes | 2| 85.7| | |files_tests | 27| 97.6| | |loc_R | 793| 61.5| | |loc_vignettes | 286| 62.2| | |loc_tests | 1418| 91.1| | |num_vignettes | 2| 89.2| | |data_size_total | 1301| 61.1| | |data_size_median | 1301| 65.7| | |n_fns_r | 52| 57.9| | |n_fns_r_exported | 26| 74.6| | |n_fns_r_not_exported | 26| 48.5| | |n_fns_per_file_r | 1| 0.2|TRUE | |num_params_per_fn | 3| 33.6| | |loc_per_fn_r | 36| 82.8| | |loc_per_fn_r_exp | 30| 62.7| | |loc_per_fn_r_not_exp | 39| 85.5| | |rel_whitespace_R | 27| 72.7| | |rel_whitespace_vignettes | 23| 48.1| | |rel_whitespace_tests | 17| 87.9| | |doclines_per_fn_exp | 32| 38.2| | |doclines_per_fn_not_exp | 0| 0.0|TRUE | |fn_call_network_size | 33| 57.5| | ---

3a. 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.


4. goodpractice and other checks

Details of goodpractice checks (click to open)

#### 3a. Continuous Integration Badges [![R-CMD-check](https://github.com/ropensci/concstats/workflows/R-CMD-check/badge.svg)](https://github.com/ropensci/concstats/actions) [![pkgcheck](https://github.com/ropensci/concstats/workflows/pkgcheck/badge.svg)](https://github.com/ropensci/concstats/actions) **GitHub Workflow Results** | id|name |conclusion |sha | run_number|date | |----------:|:--------------------------|:----------|:------|----------:|:----------| | 8209916411|pages build and deployment |success |c450c9 | 90|2024-03-08 | | 8209916557|pkgcheck |NA |c450c9 | 62|2024-03-08 | | 8209916554|R-CMD-check |NA |c450c9 | 97|2024-03-08 | | 8209916553|test-coverage |success |c450c9 | 44|2024-03-08 | --- #### 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: 93.87 #### Cyclocomplexity with [cyclocomp](https://github.com/MangoTheCat/cyclocomp) The following functions have cyclocomplexity >= 15: function | cyclocomplexity --- | --- concstats_hhi | 27 concstats_all_comp | 26 concstats_all_inequ | 26 concstats_entropy | 25 concstats_gini | 25 concstats_all_mstruct | 20 concstats_dom | 20 concstats_firm | 20 concstats_nrs_eq | 20 concstats_top | 20 concstats_top_df | 20 concstats_top3 | 20 concstats_top3_df | 20 concstats_top5 | 20 concstats_top5_df | 20 concstats_concstats | 18 concstats_grs | 18 concstats_hhi_d | 18 concstats_hhi_min | 18 concstats_palma | 18 concstats_simpson | 18 concstats_sten | 18 concstats_shares | 15 #### Static code analyses with [lintr](https://github.com/jimhester/lintr) [lintr](https://github.com/jimhester/lintr) found the following 16 potential issues: message | number of times --- | --- Avoid library() and require() calls in packages | 5 Lines should not be more than 80 characters. This line is 81 characters. | 3 Lines should not be more than 80 characters. This line is 82 characters. | 1 Lines should not be more than 80 characters. This line is 85 characters. | 3 Lines should not be more than 80 characters. This line is 86 characters. | 2 Lines should not be more than 80 characters. This line is 87 characters. | 2


Package Versions

|package |version | |:--------|:---------| |pkgstats |0.1.3.11 | |pkgcheck |0.1.2.15 | |srr |0.0.1.195 |