Submission of 'mapindia' package

shubhamdutta26 commented 1 day ago

Submitting Author Name: Shubham Dutta Submitting Author Github Handle: !--author1-->@shubhamdutta26<!--end-author1-- Other Package Authors Github handles: (comma separated, delete if none) @github_handle1, @github_handle2 Repository: https://github.com/shubhamdutta26/mapindia Version submitted: 1.0.0 Submission type: Standard Editor: TBD Reviewers: TBD

Archive: TBD Version accepted: TBD Language: en

Paste the full DESCRIPTION file inside a code block below:

Type: Package
Package: mapindia
Title: Plot Map of the Indian Subcontinent
Version: 1.0.0
Authors@R: 
    person("Shubham", "Dutta", , "shubhamdutta26@gmail.com", role = c("aut", "cre", "cph"),
           comment = c(ORCID = "0000-0001-8484-0717"))
Maintainer: Shubham Dutta <shubhamdutta26@gmail.com>
Description: Get map data frames for the Indian subcontinent with different region
    levels (e.g., district, state). The package also offers convenience functions
    for plotting choropleths, visualizing spatial data, and handling state/district
    codes.
License: MIT + file LICENSE
URL: https://github.com/shubhamdutta26/mapindia, https://www.shubhamdutta.com/mapindia/
BugReports: https://github.com/shubhamdutta26/mapindia/issues
Depends: 
    R (>= 2.10)
Imports: 
    ggplot2,
    mapindiatools,
    rlang,
    sf,
    vdiffr
Suggests: 
    knitr,
    rmarkdown,
    testthat (>= 3.0.0)
Config/testthat/edition: 3
Encoding: UTF-8
LazyData: true
RoxygenNote: 7.3.2
VignetteBuilder: knitr

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
- [ ] data validation and testing
- [ ] workflow automation
- [ ] version control
- [ ] citation management and bibliometrics
- [ ] scientific software wrappers
- [ ] field and lab reproducibility tools
- [ ] database software bindings
- [x] geospatial data
- [ ] text analysis
Explain how and why the package falls under these categories (briefly, 1-2 sentences): The mapindia package can be used to plot state and district levels maps of the Indian subcontinent. The package also offers convenience functions for plotting choropleths, visualizing spatial data, and handling state/district codes.
Who is the target audience and what are scientific applications of this package? People who want to work with geospatial data of India
Are there other R packages that accomplish the same thing? If so, how does yours differ or meet our criteria for best-in-category? To the best of my knowledge, no.
(If applicable) Does your package comply with our guidance around Ethics, Data Privacy and Human Subjects Research? Yes
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. NA
Explain reasons for any pkgcheck items which your package is unable to pass. NA

Technical checks

Confirm each of the following by checking the box.

[x] I have read the rOpenSci packaging guide.
[x] I have read the author guide and I expect to maintain this package for at least 2 years or to find a replacement.

This package:

[x] does not violate the Terms of Service of any service it interacts with.
[x] has a CRAN and OSI accepted license.
[x] contains a README with instructions for installing the development version.
[x] includes documentation with examples for all functions, created with roxygen2.
[x] contains a vignette with examples of its essential functions and uses.
[x] has a test suite.
[x] has continuous integration, including reporting of test coverage.

Publication options

[x] 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](http://besjournals.onlinelibrary.wiley.com/hub/journal/10.1111/(ISSN)2041-210X/journal-resources/policy-on-publishing-code.html)) - (*Scope: Do consider MEE's [Aims and Scope](http://besjournals.onlinelibrary.wiley.com/hub/journal/10.1111/(ISSN)2041-210X/aims-and-scope/read-full-aims-and-scope.html) 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

[x] I agree to abide by rOpenSci's Code of Conduct during the review process and in maintaining my package should it be accepted.

ropensci-review-bot commented 1 day ago

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

ropensci-review-bot commented 1 day ago

:rocket:

Editor check started

:wave:

ropensci-review-bot commented 1 day ago

Checks for mapindia (v1.0.0)

git hash: 27f493f5

:heavy_check_mark: Package name is available
:heavy_check_mark: has a 'codemeta.json' file.
:heavy_multiplication_x: does not have a 'contributing' file.
:heavy_multiplication_x: The following function has no documented return value: [mapindia_crs]
:heavy_check_mark: uses 'roxygen2'.
:heavy_check_mark: 'DESCRIPTION' has a URL field.
:heavy_check_mark: 'DESCRIPTION' has a BugReports field.
:heavy_check_mark: Package has at least one HTML vignette
:heavy_multiplication_x: These functions do not have examples: [mapindia_crs].
:heavy_check_mark: Package has continuous integration checks.
:heavy_check_mark: Package coverage is 98.3%.
:heavy_check_mark: R CMD check found no errors.
:heavy_check_mark: R CMD check found no warnings.
:eyes: Function names are duplicated in other packages

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

(Checks marked with :eyes: may be optionally addressed.)

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 | 38| |internal |mapindia | 18| |internal |utils | 9| |internal |stats | 5| |imports |ggplot2 | 7| |imports |mapindiatools | 4| |imports |sf | 3| |imports |rlang | NA| |imports |vdiffr | NA| |suggests |knitr | NA| |suggests |rmarkdown | NA| |suggests |testthat | 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

c (11), tolower (7), data.frame (2), list (2), merge (2), sort (2), sprintf (2), by (1), do.call (1), for (1), if (1), length (1), match (1), nchar (1), return (1), sub (1), which (1)

mapindia

map_india (4), mapindia_crs (2), static_merge (2), code_info (1), code_info.character (1), code_info.numeric (1), codes (1), get_code_info (1), map_with_data (1), mapindia_transform (1), mapindia_transform.data.frame (1), mapindia_transform.sf (1), perform_transform (1)

utils

data (9)

ggplot2

aes (2), `% (1), element_blank (1), geom_sf (1), geom_sf_text (1), theme (1)

stats

df (5)

mapindiatools

fetch_codes (3), centroid_labels (1)

sf

st_as_sf (2), st_transform (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 8 files) and - 1 authors - 1 vignette - 2 internal data files - 5 imported packages - 15 exported functions (median 12 lines of code) - 22 non-exported functions in R (median 5 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 | 8| 47.7| | |files_vignettes | 1| 61.9| | |files_tests | 8| 84.0| | |loc_R | 282| 29.8| | |loc_vignettes | 57| 10.8| | |loc_tests | 372| 65.2| | |num_vignettes | 1| 58.8| | |data_size_total | 3142| 63.6| | |data_size_median | 1571| 66.2| | |n_fns_r | 37| 46.0| | |n_fns_r_exported | 15| 58.3| | |n_fns_r_not_exported | 22| 42.4| | |n_fns_per_file_r | 4| 58.9| | |num_params_per_fn | 2| 8.2| | |loc_per_fn_r | 10| 29.0| | |loc_per_fn_r_exp | 12| 28.3| | |loc_per_fn_r_not_exp | 5| 10.9| | |rel_whitespace_R | 23| 39.0| | |rel_whitespace_vignettes | 44| 16.2| | |rel_whitespace_tests | 20| 63.4| | |doclines_per_fn_exp | 36| 43.6| | |doclines_per_fn_not_exp | 0| 0.0|TRUE | |fn_call_network_size | 13| 36.4| | ---

2a. Network visualisation

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

3. `goodpractice` and other checks

Details of goodpractice checks (click to open)

#### 3a. Continuous Integration Badges [![R-CMD-check.yaml](https://github.com/shubhamdutta26/mapindia/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/shubhamdutta26/mapindia/actions) **GitHub Workflow Results** | id|name |conclusion |sha | run_number|date | |-----------:|:--------------------------|:----------|:------|----------:|:----------| | 11672706672|pages build and deployment |success |c86b82 | 12|2024-11-04 | | 11672673330|pkgdown.yaml |success |27f493 | 9|2024-11-04 | | 11672673318|R-CMD-check.yaml |success |27f493 | 9|2024-11-04 | | 11672673319|test-coverage.yaml |success |27f493 | 9|2024-11-04 | --- #### 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: 98.33 #### Cyclocomplexity with [cyclocomp](https://github.com/MangoTheCat/cyclocomp) The following function have cyclocomplexity >= 15: function | cyclocomplexity --- | --- plot_india | 19 #### Static code analyses with [lintr](https://github.com/jimhester/lintr) [lintr](https://github.com/jimhester/lintr) found no issues with this package!

4. Other Checks

Details of other checks (click to open)

:heavy_multiplication_x: The following 2 function names are duplicated in other packages: - - `codes` from encode, manifestoR, str2str - - `map_with_data` from usmap

Package Versions

|package |version | |:--------|:--------| |pkgstats |0.2.0.46 | |pkgcheck |0.1.2.63 |

Editor-in-Chief Instructions:

Processing may not proceed until the items marked with :heavy_multiplication_x: have been resolved.

shubhamdutta26 commented 1 day ago

I will re-submit.

ropensci / software-review