software-review feowR: Download shapefiles of Freshwater Ecoregions of the World (FEOW)

trafficstars

Submitting Author Name: Bruno Henrique Mioto Stabile Submitting Author Github Handle: @brunomioto Other Package Authors Github handles: (comma separated, delete if none) Repository: https://github.com/brunomioto/feowR Version submitted: Submission type: Standard Editor: TBD Reviewers: TBD

Archive: TBD Version accepted: TBD Language: en

Paste the full DESCRIPTION file inside a code block below:

Package: feowR
Title: Download shapefiles of Freshwater Ecoregions of the World (FEOW)
Description: Get access to all shapefiles from Freshwater Ecoregions of the World (FEOW) and a list with IDs and names.
Version: 0.0.0.9000
Authors@R: 
    c(person(given = "Bruno",
             family = "Mioto",
             role = c("aut", "cre"),
             email = "[email protected]"),
      person(given = "The Nature Conservancy and World Wildlife Fund, Inc",
             role = "cph"))
License: CC BY 4.0 + file LICENSE
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.1
URL: https://github.com/brunomioto/feowR, https://brunomioto.github.io/feowR/
BugReports: https://github.com/brunomioto/feowR/issues
Imports: 
    cli,
    curl,
    piggyback,
    sf
Depends: 
    R (>= 2.10)
LazyData: true
Suggests: 
    dplyr,
    ggplot2,
    testthat (>= 3.0.0)
Config/testthat/edition: 3
Config/Needs/website: rmarkdown

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.):
- [X] 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):

It helps the user to retrieve shapefiles data from Freshwater Ecoregions of the World (FEOW) and save it on the working directory.

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

Main use is for biologists (like me) who needs to use this data in other analyses, like selecting points that falls inside each ecoregion.

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

No

(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.
Explain reasons for any pkgcheck items which your package is unable to pass.

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)
(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

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

Jun 24 '24 00:06 brunomioto

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

Jun 24 '24 00:06 ropensci-review-bot

:rocket:

Editor check started

:wave:

Jun 24 '24 00:06 ropensci-review-bot

Sorry that the checks haven't appeared @brunomioto. GitHub has recently been responding to some of the necessary steps with "Unexpected error" messages. Your glitch has provided enough information for us to fix on our side so it shouldn't happen again. In the meantime, I'll manually push the checks in a moment.

Jun 24 '24 13:06 mpadge

Checks for feowR (v0.0.0.9000)

git hash: 90d82190

:heavy_check_mark: Package name is available
:heavy_check_mark: has a 'codemeta.json' file.
:heavy_check_mark: has a 'contributing' file.
: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_check_mark: All functions have examples.
:heavy_check_mark: Package has continuous integration checks.
:heavy_check_mark: Package coverage is 94.1%.
:heavy_check_mark: R CMD check found no errors.
:heavy_check_mark: R CMD check found no warnings.

Package License: CC BY 4.0 + 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
imports	cli	NA
imports	httr	NA
imports	piggyback	NA
imports	sf	NA
suggests	dplyr	NA
suggests	ggplot2	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(<path/to/repo>)', and examining the 'external_calls' table.

NOTE: No imported packages appear to have 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 2 files) and
1 authors
1 vignette
1 internal data file
4 imported packages
1 exported function (median 19 lines of code)
no non-exported function in R (median 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	2	13.6
files_vignettes	1	68.4
files_tests	3	75.2
loc_R	21	1.7	TRUE
loc_vignettes	31	4.2	TRUE
loc_tests	24	14.8
num_vignettes	1	64.8
data_size_total	5417	67.6
data_size_median	5417	74.9
n_fns_r	1	0.0	TRUE
n_fns_r_exported	1	0.0	TRUE
n_fns_r_not_exported	0	0.0	TRUE
n_fns_per_file_r	1	0.2	TRUE
num_params_per_fn	1	1.6	TRUE
loc_per_fn_r	19	57.3
loc_per_fn_r_exp	19	44.7
rel_whitespace_R	62	11.6
rel_whitespace_vignettes	52	10.5
rel_whitespace_tests	75	33.0
doclines_per_fn_exp	19	12.2
fn_call_network_size	0	0.0	TRUE

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

GitHub Workflow Results

id	name	conclusion	sha	run_number	date
9637299025	pages build and deployment	success	ea0505	15	2024-06-23
9637288502	pkgcheck	success	90d821	3	2024-06-23
9637288498	pkgdown	success	90d821	14	2024-06-23
9637288499	R-CMD-check	success	90d821	7	2024-06-23
9637288503	test-coverage	success	90d821	10	2024-06-23

3b. `goodpractice` results

`R CMD check` with rcmdcheck

rcmdcheck found no errors, warnings, or notes

Test coverage with covr

Package coverage: 94.12

Cyclocomplexity with cyclocomp

No functions have cyclocomplexity >= 15

Static code analyses with lintr

lintr found the following 5 potential issues:

message	number of times
Avoid library() and require() calls in packages	3
Lines should not be more than 80 characters. This line is 93 characters.	1
Lines should not be more than 80 characters. This line is 94 characters.	1

Package Versions

package	version
pkgstats	0.1.5.2
pkgcheck	0.1.2.42

Editor-in-Chief Instructions:

This package is in top shape and may be passed on to a handling editor

Jun 24 '24 13:06 ropensci-review-bot

Just updated the package adding a test for "No internet connection". The code is now 100% covered.

Jun 24 '24 19:06 brunomioto

Dear @brunomioto, Thank you for your submission. We are in the process of looking for a handling editor. Thanks, Julia

Jun 29 '24 15:06 jooolia

@ropensci-review-bot assign @maelle as editor

Jul 02 '24 16:07 jooolia

I'm sorry human, I don't understand that. You can see what commands I support by typing:

@ropensci-review-bot help

Jul 02 '24 16:07 ropensci-review-bot

@ropensci-review-bot assign @maelle as editor

Jul 02 '24 16:07 jooolia

Assigned! @maelle is now the editor

Jul 02 '24 16:07 ropensci-review-bot

Dear @brunomioto, thanks a lot for your submission. Unfortunately after reviewing the package a bit more, we think it is out of scope as it has only one simple function, even if such functionality could help scientists get this data. Furthermore there might be some compliance issue with the copyright of the data.

Note that today the website for FEOW is down so I understand the motivation behind resharing the data. :sweat_smile:

A package helping to download the same data could be in scope if it:

downloaded the data from the original site (with caching) unless permission is given to redistribute,
fulfilled with the copyright, and
ideally implemented some other functionality that facilitates working with these ecoregions (such as filtering before importing, identifying ecoregion for a given coordinates, etc). An inspiration could be http://docs.ropensci.org/rnaturalearth/

Thanks again for your submission!

Jul 08 '24 13:07 maelle

@ropensci-review-bot out of scope

Jul 08 '24 13:07 maelle

software-review software-review copied to clipboard

feowR: Download shapefiles of Freshwater Ecoregions of the World (FEOW)

Scope

Technical checks

Publication options

Code of conduct

Checks for feowR (v0.0.0.9000)

1. Package Dependencies

2. Statistical Properties

2a. Network visualisation

3. goodpractice and other checks

3a. Continuous Integration Badges

3b. goodpractice results

R CMD check with rcmdcheck

Test coverage with covr

Cyclocomplexity with cyclocomp

Static code analyses with lintr

Editor-in-Chief Instructions:

software-review
software-review copied to clipboard

3. `goodpractice` and other checks

3b. `goodpractice` results

`R CMD check` with rcmdcheck