ropensci / software-review

rOpenSci Software Peer Review.
292 stars 104 forks source link

Submission: set6 #383

Closed RaphaelS1 closed 4 years ago

RaphaelS1 commented 4 years ago

Submitting Author: Raphael Sonabend (@RaphaelS1)
Repository: https://github.com/xoopR/set6 Version submitted: 0.1.4 Editor: TBD
Reviewer 1: TBD
Reviewer 2: TBD
Archive: TBD
Version accepted: TBD


Package: set6
Title: R6 Mathematical Sets Interface
Version: 0.1.4
Authors@R: 
      c(person(given = "Raphael",
             family = "Sonabend",
             role = c("aut","cre"),
             email = "raphael.sonabend.15@ucl.ac.uk",
             comment = c(ORCID = "0000-0001-9225-4654")),
      person(given = "Franz",
             family = "Kiraly",
             role = "aut",
             email = "f.kiraly@ucl.ac.uk"))
Description: An object-oriented package for mathematical sets, upgrading the current gold-standard {sets}. Many forms of mathematical sets are implemented, including (countably finite) sets, tuples, intervals (countably infinite or uncountable), and fuzzy variants. Wrappers extend functionality by allowing symbolic representations of complex operations on sets, including unions, (cartesian) products, exponentiation, and differences (asymmetric and symmetric).
LinkingTo: Rcpp
Imports: checkmate, Rcpp, R6, utils
Suggests: knitr, testthat, devtools, rmarkdown
License: MIT + file LICENSE
LazyData: true
URL: https://xoopR.github.io/set6/, https://github.com/xoopR/set6
BugReports: https://github.com/xoopR/set6/issues
VignetteBuilder: 
    knitr
Encoding: UTF-8
RoxygenNote: 7.1.0
Roxygen: list(markdown = TRUE, r6 = TRUE)

Scope

set6 implements mathematical sets, tuples, and conditional sets thus allowing the manipulation and organisation of data of any types in R.

set6 is built using the R6 paradigm and thus serves as an alternative to the S3/S4 sets package; any object-oriented package using R6 can make use of set6 as a single base class to unify R types. Specific applications that it currently is being used for include representation of distribution and parameter domains, and validation checks.

There are a few packages in R that handle sets, however with the exception of sets, all are primarily focused on one specific purpose, e.g. fuzzy sets, clustering, 'tidy' representation. The sets package is the most general but this is built using an older object-oriented paradigm. To my knowledge, no other package can handle symbolic representation in the same way as set6 because of the use of R6 classes.

Technical checks

Confirm each of the following by checking the box.

This package:

Publication options

JOSS Options - [x] The package has an **obvious research application** according to [JOSS's definition](https://joss.readthedocs.io/en/latest/submitting.html#submission-requirements). - [x] The package contains a `paper.md` matching [JOSS's requirements](https://joss.readthedocs.io/en/latest/submitting.html#what-should-my-paper-contain) with a high-level description in the package root or in `inst/`. - [x] The package is deposited in a long-term repository with the DOI: - (*Do not submit your package separately to JOSS*)
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

annakrystalli commented 4 years ago

Hello @RaphaelS1 and many thanks for your submissions.

In the end after discussion we decided that because there is not a research specific aspact to it, the package is sadly too general for the rOpenSci scope.

Thanks again for taking the time to submit.

RaphaelS1 commented 4 years ago

Okay, thanks very much for your time!