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

test submission for geodist (#8) #21

Open
27 tasks
mpadge opened this issue Sep 6, 2021 · 10 comments
Open
27 tasks

test submission for geodist (#8) #21

mpadge opened this issue Sep 6, 2021 · 10 comments

Comments

@mpadge
Copy link
Member

mpadge commented Sep 6, 2021

Submitting Author: Name (@mpadge)
Repository: https://github.com/hypertidy/geodist
Version submitted:
Submission type: Standard
Editor: TBD
Reviewers: TBD

Archive: TBD
Version accepted: TBD


  • Paste the full DESCRIPTION file inside a code block below:

Scope

  • Please indicate which category or categories from our package fit policies this package falls under: (Please check an appropriate box below. If you are unsure, we suggest you make a pre-submission inquiry.):

    • data retrieval
    • data extraction
    • data munging
    • data deposition
    • workflow automation
    • version control
    • citation management and bibliometrics
    • scientific software wrappers
    • field and lab reproducibility tools
    • database software bindings
    • geospatial data
    • text analysis
  • Explain how and why the package falls under these categories (briefly, 1-2 sentences):

  • Who is the target audience and what are scientific applications of this package?

  • Are there other R packages that accomplish the same thing? If so, how does yours differ or meet our criteria for best-in-category?

  • (If applicable) Does your package comply with our guidance around Ethics, Data Privacy and Human Subjects Research?

  • If you made a pre-submission inquiry, please paste the link to the corresponding issue, forum post, or other discussion, or @tag the editor you contacted.

Technical checks

Confirm each of the following by checking the box.

This package:

Publication options

  • Do you intend for this package to go on CRAN?

  • Do you intend for this package to go on Bioconductor?

  • Do you wish to submit an Applications Article about your package to Methods in Ecology and Evolution? If so:

MEE Options
  • The package is novel and will be of interest to the broad readership of the journal.
  • The manuscript describing the package is no longer than 3000 words.
  • You intend to archive the code for the package in a long-term repository which meets the requirements of the journal (see MEE's Policy on Publishing Code)
  • (Scope: Do consider MEE's Aims and Scope for your manuscript. We make no guarantee that your manuscript will be within MEE scope.)
  • (Although not required, we strongly recommend having a full manuscript prepared when you submit here.)
  • (Please do not submit your package separately to Methods in Ecology and Evolution)

Code of conduct

@ropensci-review-bot
Copy link
Collaborator

Thanks for submitting to rOpenSci, our editors and @ropensci-review-bot will reply soon. Type @ropensci-review-bot help for help.

@ropensci-review-bot
Copy link
Collaborator

🚀

Editor check started

👋

@ropensci-review-bot
Copy link
Collaborator

Checks for geodist (v0.0.7.012)

git hash: 988118a5

  • ✔️ Package uses 'roxygen2'
  • ✔️ Package has a 'contributing.md' file
  • ✖️ Package does not have a 'CITATION' file
  • ✔️ Package has a 'codemeta.json' file
  • ✔️ All functions have examples
  • ✔️ Package 'DESCRIPTION' has a URL field
  • ✔️ Package 'DESCRIPTION' has a BugReports field
  • ✔️ Package is already on CRAN
  • ✔️ Package has continuous integration checks
  • ✔️ Package coverage is 92.5%
  • ✔️ 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: MIT + file LICENSE


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 (87% in 14 files), C/C++ Header (3% in 3 files) and R (10% in 5 files)
  • 2 authors
  • 1 vignette
  • no internal data file
  • 1 imported package
  • 3 exported functions (median 27 lines of code)
  • 42 non-exported functions in R (median 12 lines of code)
  • 94 C/C++ functions (median 27 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 5 29.8
files_src 17 95.7
files_vignettes 1 64.8
files_tests 5 78.5
loc_R 319 30.2
loc_src 2783 80.3
loc_vignettes 182 67.7
loc_tests 416 68.4
num_vignettes 1 60.7
n_fns_r 45 44.8
n_fns_r_exported 3 10.4
n_fns_r_not_exported 42 53.5
n_fns_src 94 94.8
n_fns_per_file_r 6 68.2
n_fns_per_file_src 7 57.3
num_params_per_fn 4 54.3
loc_per_fn_r 13 52.9
loc_per_fn_r_exp 27 60.6
loc_per_fn_r_not_exp 12 55.9
loc_per_fn_src 27 84.4
rel_whitespace_R 30 48.8
rel_whitespace_src 16 94.9
rel_whitespace_vignettes 12 69.6
rel_whitespace_tests 14 83.0
doclines_per_fn_exp 38 46.5
doclines_per_fn_not_exp 0 0.0 TRUE
fn_call_network_size 215 88.2

1a. Network visualisation

Interactive network visualisation of calls between objects in package can be viewed by clicking here


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 f45a85 2021-02-11
R-CMD-check success f45a85 2021-02-11
test-coverage success f45a85 2021-02-11

3b. goodpractice results

R CMD check with rcmdcheck

rcmdcheck found no errors, warnings, or notes

Test coverage with covr

Package coverage: 92.49

Cyclocomplexity with cyclocomp

No functions have cyclocomplexity >= 15

Static code analyses with lintr

lintr found no issues with this package!


Package Versions

package version
pkgstats 0.0.0.301
pkgcheck 0.0.1.380


Editor-in-Chief Instructions:

Processing may not proceed until the items marked with ✖️ have been resolved.

@ropensci-review-bot
Copy link
Collaborator

Checks for geodist (v0.0.7.012)

git hash: 988118a5

  • ✔️ Package uses 'roxygen2'.
  • ✔️ Package has a 'contributing.md' file.
  • ✖️ Package does not have a 'CITATION' file.
  • ✔️ Package has a 'codemeta.json' file.
  • ✔️ All functions have examples.
  • ✔️ Package has at least one HTML vignette
  • ✔️ Package 'DESCRIPTION' has a URL field.
  • ✔️ Package 'DESCRIPTION' has a BugReports field.
  • ✔️ Package is already on CRAN.
  • ✔️ Package has continuous integration checks.
  • ✔️ Package coverage is 91.9%.
  • ✔️ 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: MIT + file LICENSE


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 (87% in 14 files), C/C++ Header (3% in 3 files) and R (10% in 5 files)
  • 2 authors
  • 1 vignette
  • no internal data file
  • 1 imported package
  • 3 exported functions (median 27 lines of code)
  • 42 non-exported functions in R (median 12 lines of code)
  • 94 C/C++ functions (median 27 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 5 29.8
files_src 17 95.7
files_vignettes 1 64.8
files_tests 5 78.5
loc_R 319 30.2
loc_src 2783 80.3
loc_vignettes 182 67.7
loc_tests 416 68.4
num_vignettes 1 60.7
n_fns_r 45 44.8
n_fns_r_exported 3 10.4
n_fns_r_not_exported 42 53.5
n_fns_src 94 94.8
n_fns_per_file_r 6 68.2
n_fns_per_file_src 7 57.3
num_params_per_fn 4 54.3
loc_per_fn_r 13 52.9
loc_per_fn_r_exp 27 60.6
loc_per_fn_r_not_exp 12 55.9
loc_per_fn_src 27 84.4
rel_whitespace_R 30 48.8
rel_whitespace_src 16 94.9
rel_whitespace_vignettes 12 69.6
rel_whitespace_tests 14 83.0
doclines_per_fn_exp 38 46.5
doclines_per_fn_not_exp 0 0.0 TRUE
fn_call_network_size 215 88.2

1a. Network visualisation

Interactive network visualisation of calls between objects in package can be viewed by clicking here


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 f45a85 2021-02-11
R-CMD-check success f45a85 2021-02-11
test-coverage success f45a85 2021-02-11

3b. goodpractice results

R CMD check with rcmdcheck

rcmdcheck found no errors, warnings, or notes

Test coverage with covr

Package coverage: 91.94

Cyclocomplexity with cyclocomp

No functions have cyclocomplexity >= 15

Static code analyses with lintr

lintr found no issues with this package!


Package Versions

package version
pkgstats 0.0.2.1
pkgcheck 0.0.1.493


Editor-in-Chief Instructions:

Processing may not proceed until the items marked with ✖️ have been resolved.

@ropensci-review-bot
Copy link
Collaborator

Checks for MazamaSpatialUtils (v0.7.6)

git hash: 122af317

  • ✔️ Package is already on CRAN.
  • ✖️ does not have a 'CITATION' file.
  • ✖️ does not have 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
  • ✖️ These functions do not have examples: [codeToCountry.Rd].
  • ✔️ Package has continuous integration checks.
  • ✖️ Package coverage is 9.6% (should be at least 75%).
  • ✔️ R CMD check found no errors.
  • ✖️ R CMD check found 1warning.

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

Package License: GPL-2


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 R (100% in 49 files) and
  • 12 authors
  • 4 vignettes
  • 4 internal data files
  • 10 imported packages
  • 62 exported functions (median 32 lines of code)
  • 74 non-exported functions in R (median 56 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 49 95.2
files_vignettes 0 0.0 TRUE
files_tests 16 93.5
loc_R 3062 90.4
loc_tests 733 79.3
num_vignettes 4 96.0 TRUE
data_size_total 3138067 99.3 TRUE
data_size_median 838915 98.4 TRUE
n_fns_r 136 78.9
n_fns_r_exported 62 90.2
n_fns_r_not_exported 74 70.6
n_fns_per_file_r 1 18.3
num_params_per_fn 2 10.7
loc_per_fn_r 42 92.3
loc_per_fn_r_exp 32 67.9
loc_per_fn_r_not_exp 56 96.3 TRUE
rel_whitespace_R 38 96.4 TRUE
rel_whitespace_tests 39 95.5 TRUE
doclines_per_fn_exp 37 44.9
doclines_per_fn_not_exp 0 0.0 TRUE
fn_call_network_size 101 77.1

1a. Network visualisation

Interactive network visualisation of calls between objects in package can be viewed by clicking here


2. goodpractice and other checks

Details of goodpractice and other checks (click to open)

3a. Continuous Integration Badges

travis


3b. goodpractice results

R CMD check with rcmdcheck

R CMD check generated the following warning:

  1. checking data for ASCII and uncompressed saves ... WARNING

Note: significantly better compression could be obtained
by using R CMD build --resave-data
old_size new_size compress
SimpleCountriesEEZ.rda 1.3Mb 814Kb xz
SimpleCountries.rda 344Kb 274Kb xz
SimpleTimezones.rda 1.4Mb 705Kb xz
US_countyCodes.rda 39Kb 25Kb xz

R CMD check generated the following note:

  1. checking data for non-ASCII characters ... NOTE
    Note: found 17 marked UTF-8 strings

R CMD check generated the following check_fails:

  1. no_description_depends
  2. no_import_package_as_a_whole
  3. rcmdcheck_non_ascii_characters_in_data
  4. rcmdcheck_uncompressed_data_files

Test coverage with covr

Package coverage: 9.6

The following files are not completely covered by tests:

file coverage
R/convertCARBAirBasins.R 0%
R/convertEEZCountries.R 0%
R/convertEPARegions.R 0%
R/convertGACC.R 0%
R/convertGADM.R 0%
R/convertLayer.R 0%
R/convertNaturalEarthAdm1.R 0%
R/convertNWSFireZones.R 0%
R/convertOSMTimezones.R 0%
R/convertStateLegislativeDistricts.R 0%
R/convertTerrestrialEcoregions.R 0%
R/convertTMWorldBorders.R 0%
R/convertTMWorldBordersSimple.R 0%
R/convertUSCensusCBSA.R 0%
R/convertUSCensusCongress.R 0%
R/convertUSCensusCounties.R 0%
R/convertUSCensusStates.R 0%
R/convertUSCensusUrbanAreas.R 0%
R/convertUSIndianLands.R 0%
R/convertWBDHUC.R 0%
R/convertWeatherZones.R 0%
R/convertWikipediaTimezoneTable.R 0%
R/convertWorldTimezones.R 0%
R/getHUC.R 0%
R/getHUCName.R 0%
R/getState.R 0%
R/getStateCode.R 0%
R/getStateName.R 0%
R/getUSCounty.R 0%
R/installedSpatialData.R 0%
R/installSpatialData_0.6.R 0%
R/installSpatialData.R 0%
R/loadSpatialData.R 0%
R/MazamaSpatialUtils.R 36.84%
R/organizePolygons.R 0%
R/subsetHUC.R 0%
R/US_countyConversion.R 0%

Cyclocomplexity with cyclocomp

The following functions have cyclocomplexity >= 15:

function cyclocomplexity
getSpatialData 33
convertWBDHUC 28
organizePolygons 21
convertStateLegislativeDistricts 19

Static code analyses with lintr

lintr found the following 823 potential issues:

message number of times
Avoid library() and require() calls in packages 4
Lines should not be more than 80 characters. 810
Use <-, not =, for assignment. 9


Package Versions

package version
pkgstats 0.0.2.16
pkgcheck 0.0.2.86


Editor-in-Chief Instructions:

Processing may not proceed until the items marked with ✖️ have been resolved.

@mpadge
Copy link
Member Author

mpadge commented Dec 1, 2021

@ropensci-review-bot check package

@ropensci-review-bot
Copy link
Collaborator

Thanks, about to send the query.

@ropensci-review-bot
Copy link
Collaborator

🚀

The following problem was found in your submission template:

  • 'author1' variable must be GitHub hanle only ('@myhandle')
    Editors: Please ensure these problems with the submission template are rectified. Package checks have been started regardless.

👋

@ropensci-review-bot
Copy link
Collaborator

Checks for geodist (v0.0.7.012)

git hash: 988118a5

  • ✔️ Package is already on CRAN.
  • ✖️ does not have a 'CITATION' file.
  • ✔️ 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 91.8%.
  • ✔️ 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: MIT + file LICENSE


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 (89% in 14 files) and R (11% in 5 files)
  • 2 authors
  • 1 vignette
  • no internal data file
  • 1 imported package
  • 3 exported functions (median 27 lines of code)
  • 42 non-exported functions in R (median 12 lines of code)
  • 94 R functions (median 27 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 5 29.8
files_src 14 94.7
files_vignettes 1 64.8
files_tests 5 78.5
loc_R 319 30.2
loc_src 2692 80.2
loc_vignettes 182 67.7
loc_tests 416 68.4
num_vignettes 1 60.7
n_fns_r 45 44.8
n_fns_r_exported 3 10.4
n_fns_r_not_exported 42 53.5
n_fns_src 94 94.8
n_fns_per_file_r 6 68.2
n_fns_per_file_src 7 57.3
num_params_per_fn 4 54.3
loc_per_fn_r 13 52.9
loc_per_fn_r_exp 27 60.6
loc_per_fn_r_not_exp 12 55.9
loc_per_fn_src 27 84.4
rel_whitespace_R 30 48.8
rel_whitespace_src 16 94.7
rel_whitespace_vignettes 12 69.6
rel_whitespace_tests 14 83.0
doclines_per_fn_exp 38 46.5
doclines_per_fn_not_exp 0 0.0 TRUE
fn_call_network_size 201 87.5

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

https://github

GitHub Workflow Results

name conclusion sha date
pkgdown success f45a85 2021-02-11
R-CMD-check success f45a85 2021-02-11
test-coverage success f45a85 2021-02-11

3b. goodpractice results

R CMD check with rcmdcheck

rcmdcheck found no errors, warnings, or notes

Test coverage with covr

Package coverage: 91.83

Cyclocomplexity with cyclocomp

No functions have cyclocomplexity >= 15

Static code analyses with lintr

lintr found no issues with this package!


Package Versions

package version
pkgstats 0.0.3.52
pkgcheck 0.0.2.185


Editor-in-Chief Instructions:

Processing may not proceed until the items marked with ✖️ have been resolved.

@ropensci-review-bot
Copy link
Collaborator

Checks for rb3 (v0.0.3)

git hash: cbb35b8a

  • ✔️ Package is already on CRAN.
  • ✖️ does not have 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
  • ✖️ These functions do not have examples: [display_template, rb3, show_templates].
  • ✖️ Package uses global assignment operator ('<<-').
  • ✔️ Package has continuous integration checks.
  • ✖️ Package coverage is 74.6% (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: 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 231
internal rb3 174
internal stats 26
internal utils 19
internal graphics 15
imports methods 14
imports httr 9
imports purrr 9
imports stringr 7
imports jsonlite 5
imports bizdays 4
imports proto 4
imports rvest 4
imports dplyr 3
imports readr 2
imports ascii 1
imports digest 1
imports base64enc 1
imports cli NA
imports rlang NA
imports yaml NA
suggests shiny 9
suggests miniUI 2
suggests testthat NA
suggests knitr NA
suggests DT NA
suggests xtable NA
suggests rmarkdown NA
suggests ggplot2 NA
suggests covr NA
suggests scales NA
suggests magrittr NA
suggests tibble NA
suggests tidyr NA
suggests fixedincome 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 (40), class (16), for (10), if (10), c (9), lapply (9), format (8), is.null (7), names (7), url (7), attr (6), F (6), length (6), as.Date (5), colnames (5), do.call (5), paste0 (4), structure (4), UseMethod (4), by (3), file.path (3), readLines (3), seq (3), as.data.frame (2), as.integer (2), body (2), match (2), options (2), parent.frame (2), Reduce (2), seq_along (2), sign (2), strptime (2), sub (2), sum (2), Sys.Date (2), table (2), try (2), as.character (1), as.numeric (1), as.POSIXct (1), basename (1), charToRaw (1), data.frame (1), dim (1), environment (1), evalq (1), exists (1), get (1), gsub (1), missing (1), order (1), print (1), rbind (1), rep (1), strftime (1), switch (1), t (1), tempdir (1)

rb3

handler (30), fields (11), server (6), download_data (5), width (5), composite (4), match_regex (4), retrieve_template (4), transmuter (4), get (3), query_cdi (3), read_fwf (3), read_marketdata (3), take (3), cachedir (2), code2month (2), fields_description (2), fields_handlers (2), fields_names (2), fields_widths (2), flatten_names (2), iter_rules (2), pass_thru_handler (2), rule_result (2), show_templates (2), unformat (2), apply_rule (1), apply_rule.class_rule (1), apply_rule.predicate_rule (1), apply_rule.regex_rule (1), as_dbl (1), as.data.frame.fields (1), cdi_get (1), clearcache (1), convert_to (1), cotahist_bdrs_get (1), cotahist_equity_get (1), cotahist_equity_options_get (1), cotahist_funds_get (1), cotahist_funds_options_get (1), cotahist_get (1), cotahist_index_options_get (1), cotahist_indexes_get (1), cotahist_units_get (1), cotahist_units_options_get (1), csv_read_file (1), curve_download (1), curve_read (1), datetime_download (1), display_template (1), field (1), fields_description.fields (1), fields_handlers.fields (1), fields_names.fields (1), fields_widths.fields (1), filter_equity_data (1), format_equity (1), format_options (1), futures_get (1), futures_mget (1), fwf_read_file (1), get_single_yc (1), idi_get (1), json_read_file (1), just_download_data (1), keys (1), match_class (1), match_predicate (1), maturity2date (1), mcsv_read_file (1), mfwf_read_file (1), new_field (1), new_part (1), options_open_interest_read (1), parse_columns (1), print.fields (1), print.parts (1), put (1), register (1), save_resource (1), settlement_prices_download (1), settlement_prices_read (1), simple_download (1), single_futures_get (1), stock_indexes_composition_download (1), stock_indexes_composition_reader (1), to_dbl (1), unzip_recursive (1)

stats

df (25), pt (1)

utils

data (15), read.table (2), methods (1), unzip (1)

graphics

text (10), lines (5)

methods

setGeneric (4), as (3), is (3), representation (2), initialize (1), setRefClass (1)

httr

content (3), GET (3), parse_url (2), POST (1)

purrr

map_chr (5), map_lgl (3), map_int (1)

shiny

dialogViewer (4), runGadget (2), shinyApp (2), h3 (1)

stringr

str_replace (2), str_sub (2), str_detect (1), str_match (1), str_pad (1)

jsonlite

fromJSON (3), toJSON (2)

bizdays

bizseq (2), add.bizdays (1), bizdayse (1)

proto

proto (4)

rvest

read_html (2), html_element (1), html_table (1)

dplyr

bind_rows (2), tibble (1)

miniUI

miniPage (2)

readr

read_file (1), read_rds (1)

ascii

ascii (1)

base64enc

base64encode (1)

digest

digest (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 18 files) and
  • 2 authors
  • 2 vignettes
  • no internal data file
  • 16 imported packages
  • 25 exported functions (median 4 lines of code)
  • 200 non-exported functions in R (median 9 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 18 78.3
files_vignettes 2 85.7
files_tests 18 95.7
loc_R 1345 75.6
loc_vignettes 203 50.1
loc_tests 276 62.4
num_vignettes 2 89.2
n_fns_r 225 91.3
n_fns_r_exported 25 73.6
n_fns_r_not_exported 200 93.2
n_fns_per_file_r 7 78.2
num_params_per_fn 1 1.6 TRUE
loc_per_fn_r 8 20.0
loc_per_fn_r_exp 4 4.3 TRUE
loc_per_fn_r_not_exp 9 27.1
rel_whitespace_R 12 66.1
rel_whitespace_vignettes 17 26.9
rel_whitespace_tests 30 68.1
doclines_per_fn_exp 42 52.8
doclines_per_fn_not_exp 0 0.0 TRUE
fn_call_network_size 134 83.7

2a. Network visualisation

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


3. goodpractice and other checks

Details of goodpractice and other checks (click to open)

3a. Continuous Integration Badges

R-CMD-check

GitHub Workflow Results

id name conclusion sha run_number date
2306339093 pages build and deployment success 38384b 33 2022-05-11
2306316808 pkgdown success cbb35b 36 2022-05-11
2306316813 R-CMD-check success cbb35b 54 2022-05-11
2306316802 test-coverage success cbb35b 54 2022-05-11

3b. goodpractice results

R CMD check with rcmdcheck

R CMD check generated the following check_fail:

  1. no_import_package_as_a_whole

Test coverage with covr

Package coverage: 74.58

Cyclocomplexity with cyclocomp

No functions have cyclocomplexity >= 15

Static code analyses with lintr

lintr found the following 3 potential issues:

message number of times
Lines should not be more than 80 characters. 3


Package Versions

package version
pkgstats 0.0.4.30
pkgcheck 0.0.3.19


Editor-in-Chief Instructions:

Processing may not proceed until the items marked with ✖️ have been resolved.

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

2 participants