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

Allow print methods to have pre- and post- messages #108

Closed
mpadge opened this issue Nov 19, 2021 · 2 comments
Closed

Allow print methods to have pre- and post- messages #108

mpadge opened this issue Nov 19, 2021 · 2 comments
Labels
enhancement New feature or request

Comments

@mpadge
Copy link
Member

mpadge commented Nov 19, 2021

For the obsolete deps checks of #44, it would be better to print a brief initial ✖️ message, list the potentially obsolete packages, and have additional text afterward referring to the recommended scaffolding. This requires modifying the general print methods to include pre- and post-messages, rather than current form of just one message printed before lists of items.

@mpadge mpadge added the enhancement New feature or request label Nov 19, 2021
@mpadge mpadge closed this as completed in 354ba57 Nov 19, 2021
@mpadge
Copy link
Member Author

mpadge commented Nov 19, 2021

Re-opened to add markdown outputs of these messages too

@mpadge
Copy link
Member Author

mpadge commented Nov 19, 2021

Checks for pkgstats (v0.0.3.051)

git hash: 8d4e7e70

  • ✔️ Package name is available
  • ✔️ has a 'CITATION' file.
  • ✖️ Package depends on the following obsolete packages: [blah]
  • ✔️ has a 'codemeta.json' file.
  • ✔️ has a 'contributing' file.
  • ✔️ uses 'roxygen2'.
  • ✔️ 'DESCRIPTION' has a URL field.
  • ✔️ 'DESCRIPTION' has a BugReports field.
  • ✖️ Package has no HTML vignettes
  • ✖️ These functions do not have examples: [pkgstats_from_archive.Rd].
  • ✔️ Package has continuous integration checks.
  • ✔️ Package coverage is 86.7%.
  • ✖️ Package contains unexpected files.
  • ✔️ 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. 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 C++ (9% in 3 files) and R (91% in 19 files)
  • 1 authors
  • no vignette
  • no internal data file
  • 9 imported packages
  • 11 exported functions (median 43 lines of code)
  • 120 non-exported functions in R (median 21 lines of code)
  • 12 R functions (median 16 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

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 77.9
files_src 3 82.9
files_vignettes 0 0.0 TRUE
files_tests 6 81.5
loc_R 2698 88.6
loc_src 277 29.5
loc_tests 145 44.6
num_vignettes 0 0.0 TRUE
n_fns_r 131 78.1
n_fns_r_exported 11 45.5
n_fns_r_not_exported 120 82.1
n_fns_src 12 83.7
n_fns_per_file_r 4 52.3
n_fns_per_file_src 4 36.9
num_params_per_fn 1 1.1 TRUE
loc_per_fn_r 23 77.1
loc_per_fn_r_exp 43 76.8
loc_per_fn_r_not_exp 22 79.5
loc_per_fn_src 16 61.3
rel_whitespace_R 19 88.1
rel_whitespace_src 24 85.5
rel_whitespace_tests 31 80.6
doclines_per_fn_exp 23 19.0
doclines_per_fn_not_exp 0 0.0 TRUE
fn_call_network_size 104 77.8

1a. Network visualisation

Click to see the interactive network visualisation of calls between objects in package


2. goodpractice and other checks

Details of goodpractice and other checks (click to open)

3a. Continuous Integration Badges

github

GitHub Workflow Results

name conclusion sha date
pkgdown success 8d4e7e 2021-11-17
R-CMD-check failure 8d4e7e 2021-11-17
test-coverage success 8d4e7e 2021-11-17

3b. goodpractice results

R CMD check with rcmdcheck

rcmdcheck found no errors, warnings, or notes

Test coverage with covr

Package coverage: 86.7

Cyclocomplexity with cyclocomp

No functions have cyclocomplexity >= 15

Static code analyses with lintr

lintr found the following 496 potential issues:

message number of times
Avoid changing the working directory, or restore it in on.exit 2
Lines should not be more than 80 characters. 494


3. Other Checks

✖️ Package contains the following unexpected files:

  • a
  • b

✖️ Package contains the following (potentially) obsolete packages:

  • sp
  • rgdal

See our Recommended Scaffolding for alternatives.


Package Versions

package version
pkgstats 0.0.3.51
pkgcheck 0.0.2.139

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

No branches or pull requests

1 participant