rfema: access data through the FEMA API.

[dylan-turner25]

Date accepted: 2022-01-23
Reviewers:
Submitting Author Name: Dylan Turner
Submitting Author Github Handle: @dylan-turner25
Repository: https://github.com/dylan-turner25/rfema
Version submitted: 0.0.0.9000
Submission type: Standard
Editor: @emilyriederer
Reviewers: @fmichonneau, @fawda123

Due date for @fmichonneau: 2021-12-10

Due date for @fawda123: 2021-12-14
Archive: TBD
Version accepted: TBD
Language: en

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

Package: rfema
Title: Access the openFEMA API
Version: 0.0.0.9000
Authors@R: 
    person(given = "Dylan",
           family = "Turner",
           role = c("aut", "cre"),
           email = "dylan.turner3@outlook.com",
           comment = c(ORCID = "000-0002-0915-7384"))
Description: `rfema` allows users to access The Federal Emergency Management Agency's (FEMA) publicly available data through their API. The package provides a set of functions to easily navigate and access data from the National Flood Insurance Program along with FEMA's various disaster aid programs, including the Hazard Mitigation Grant Program, the Public Assistance Grant Program, and the Individual Assistance Grant Program.
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.1.2
Imports: 
    dplyr,
    httr,
    memoise,
    plyr,
    rvest,
    utils
Suggests: 
    rmarkdown,
    knitr,
    testthat (>= 3.0.0),
    covr,
    vcr (>= 0.6.0)
Config/testthat/edition: 3
VignetteBuilder: knitr
URL: https://github.com/dylan-turner25/rfema
BugReports: https://github.com/dylan-turner25/rfema/issues

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

rfema allows users to access The Federal Emergency Management Agency's (FEMA) publicly available data through the open FEMA API. The package provides a set of functions to easily navigate and access all data sets provided by FEMA, including (but not limited to) data from the National Flood Insurance Program and FEMA's various disaster aid programs.

• Who is the target audience and what are scientific applications of this package?
  rfema is intended to be used by researchers that require the use of data that is available through the FEMA API, but may not have familiarity in working with APIs.

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

I am unaware of any other packages that offer similar functionality.

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

N/A

• 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.

• [ x] I have read the guide for authors and rOpenSci packaging guide.

This package:

• does not violate the Terms of Service of any service it interacts with.
• has a CRAN and OSI accepted license.
• contains a README with instructions for installing the development version.
• includes documentation with examples for all functions, created with roxygen2.
• contains a vignette with examples of its essential functions and uses.
• has a test suite.
• has continuous integration, including reporting of test coverage using services such as Travis CI, Coveralls and/or CodeCov.

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

• 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]

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

[ropensci-review-bot]

🚀

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]

Checks for rfema (v0.0.0.9000)

git hash: dcc9bd2c

• ✔️ Package name is available
• ✖️ does not have a 'CITATION' file.
• ✔️ has a 'codemeta.json' file.
• ✖️ does not have 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: [bulk_dl.Rd].
• ✔️ Package has continuous integration checks.
• ✔️ Package coverage is 90.6%.
• ✔️ 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 R (100% in 7 files) and
• 1 authors
• 1 vignette
• no internal data file
• 6 imported packages
• 9 exported functions (median 13 lines of code)
• 1 non-exported function in R (median 54 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	7	41.4
files_vignettes	1	64.8
files_tests	10	88.6
loc_R	247	23.5
loc_tests	1483	89.3
num_vignettes	1	60.7
n_fns_r	10	6.8
n_fns_r_exported	9	38.9
n_fns_r_not_exported	1	0.0	TRUE
n_fns_per_file_r	1	13.9
num_params_per_fn	4	54.3
loc_per_fn_r	16	65.0
loc_per_fn_r_exp	13	32.2
loc_per_fn_r_not_exp	54	96.0	TRUE
rel_whitespace_R	40	49.6
rel_whitespace_tests	4	82.3
doclines_per_fn_exp	18	10.1
doclines_per_fn_not_exp	0	0.0	TRUE
fn_call_network_size	0	0.0	TRUE

---

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 Workflow Results

name	conclusion	sha	date
R-CMD-check	success	dcc9bd	2021-11-09

---

3b. goodpractice results

R CMD check with rcmdcheck

R CMD check generated the following note:

1. checking dependencies in R code ... NOTE
   Namespaces in Imports field not imported from:
   ‘dplyr’ ‘httr’ ‘plyr’ ‘rvest’
   All declared Imports should be used.

R CMD check generated the following check_fail:

1. rcmdcheck_imports_not_imported_from

Test coverage with covr

Package coverage: 90.56

Cyclocomplexity with cyclocomp

No functions have cyclocomplexity >= 15

Static code analyses with lintr

lintr found the following 75 potential issues:

message	number of times
Avoid 1:length(...) expressions, use seq_len.	1
Avoid using sapply, consider vapply instead, that's type safe	3
Lines should not be more than 80 characters.	71

---

Package Versions

package	version
pkgstats	0.0.2.72
pkgcheck	0.0.2.107

---

Editor-in-Chief Instructions:

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

[ropensci-review-bot]

I'm sorry @dylan-turner25, I'm afraid I can't do that. That's something only editors are allowed to do.

[dylan-turner25]

The most recent commit has attempted to address all of the failed initial checks.

[ldecicco-USGS]

@ropensci-review-bot check package

[ropensci-review-bot]

Thanks, about to send the query.

[ropensci-review-bot]

🚀

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]

Checks for rfema (v0.0.0.9000)

git hash: 568c9783

• ✔️ Package name is available
• ✔️ has 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
• ✖️ These functions do not have examples: [bulk_dl.Rd].
• ✔️ Package has continuous integration checks.
• ✔️ Package coverage is 90.6%.
• ✔️ 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 R (100% in 7 files) and
• 1 authors
• 1 vignette
• no internal data file
• 6 imported packages
• 9 exported functions (median 13 lines of code)
• 1 non-exported function in R (median 54 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	7	41.4
files_vignettes	0	0.0	TRUE
files_tests	10	88.6
loc_R	247	23.5
loc_tests	1483	89.3
num_vignettes	1	60.7
n_fns_r	10	6.8
n_fns_r_exported	9	38.9
n_fns_r_not_exported	1	0.0	TRUE
n_fns_per_file_r	1	13.9
num_params_per_fn	4	54.3
loc_per_fn_r	16	65.0
loc_per_fn_r_exp	13	32.2
loc_per_fn_r_not_exp	54	96.0	TRUE
rel_whitespace_R	40	49.6
rel_whitespace_tests	4	82.3
doclines_per_fn_exp	18	10.1
doclines_per_fn_not_exp	0	0.0	TRUE
fn_call_network_size	0	0.0	TRUE

---

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 Workflow Results

name	conclusion	sha	date
R-CMD-check	success	568c97	2021-11-10

---

3b. goodpractice results

R CMD check with rcmdcheck

R CMD check generated the following note:

1. checking dependencies in R code ... NOTE
   Namespaces in Imports field not imported from:
   ‘dplyr’ ‘httr’ ‘plyr’ ‘rvest’
   All declared Imports should be used.

R CMD check generated the following check_fail:

1. rcmdcheck_imports_not_imported_from

Test coverage with covr

Package coverage: 90.56

Cyclocomplexity with cyclocomp

No functions have cyclocomplexity >= 15

Static code analyses with lintr

lintr found the following 75 potential issues:

message	number of times
Avoid 1:length(...) expressions, use seq_len.	1
Avoid using sapply, consider vapply instead, that's type safe	3
Lines should not be more than 80 characters.	71

---

Package Versions

package	version
pkgstats	0.0.2.72
pkgcheck	0.0.2.107

---

Editor-in-Chief Instructions:

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

[ldecicco-USGS]

@ropensci-review-bot assign @emilyriederer as editor

[ropensci-review-bot]

Assigned! @emilyriederer is now the editor