ropensci / software-review

rOpenSci Software Peer Review.
286 stars 104 forks source link

R package birdsize - scope inquiry #561

Closed diazrenata closed 1 year ago

diazrenata commented 1 year ago

Submitting Author Name: Renata Diaz Submitting Author Github Handle: !--author1-->@diazrenata<!--end-author1-- Repository: https://www.github.com/diazrenata/birdsize Submission type: Pre-submission Language: en


Package: birdsize
Title: Estimate Avian Body Size Distributions
Version: 0.0.0.9000
Authors@R: 
    person("Renata", "Diaz", , "renata.diaz@weecology.org", role = c("aut", "cre"),
           comment = c(ORCID = "0000-0003-0803-4734"))
Description: Generate estimated body size distributions for populations or communities of birds, given either species ID or species' mean body size. Designed to work naturally with the North American Breeding Bird Survey, or with any dataset of bird species, abundance, and/or mean size data.   
License: MIT + file LICENSE
URL: https://github.com/diazrenata/birdsize
BugReports: https://github.com/diazrenata/birdsize/issues
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.1
Suggests: 
    covr,
    ggplot2,
    knitr,
    rmarkdown,
    testthat (>= 3.0.0)
Config/testthat/edition: 3
Depends: 
    R (>= 2.10)
Imports: 
    rlang,
    dplyr,
    magrittr,
    purrr,
    stats
VignetteBuilder: knitr

Scope

This package automates a workflow (seen in the wild e.g. here and here) of generating estimates of body size and basal metabolic rate, from the individual to ecosystem level, for birds. I am not completely sure whether it's better described as "automating a workflow" or "standardizing a field/lab method", because it is automating - and therefore standardizing - a method used by empirical, computational ecologists to estimate body size and metabolic rate.

N/A

The target audience is ecologists/biodiversity scientists interested in studying the structure, function, and dynamics of bird populations and communities - specifically linking between abundances/population size and other dimensions of community function, like total biomass. Studying size-based and abundance-based properties of bird communities is key to understanding biodiversity and global change, but it is challenging for most ecologists because most survey methods do not collect size-related data. This package standardizes a computationally-intensive workaround for this challenge and makes it accessible to ecologists with relatively little computational training.

I have not encountered another R package that accomplishes this.

N/A

I'm still working on some of the vignettes for this package, but I wanted to reach out now to check whether this package falls within scope for ROpenSci's review process (or if there are additional functions or documentation that would support that)! Thank you.

annakrystalli commented 1 year ago

Hello @diazrenata and many thanks for the pre-submission! The editorial team has concluded the package would be a good fit for rOpenSci review and the most appropriate category would be field and lab reproducibility tools.

One thing to note is that given the package contains external data, it would be appropriate to state the source in the DESCRIPTION file under authors using author type "dtc" which stands for "data contributor".

We look forward to your submission once documentation is complete!